Click or drag to resize

ImpulsiveManeuverInformation Class

Stores all the information needed for a maneuver to be performed by an ImpulsiveManeuverSegment.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.SegmentPropagationImpulsiveManeuverInformation

Namespace:  AGI.Foundation.SegmentPropagation
Assembly:  AGI.Foundation.SegmentPropagation (in AGI.Foundation.SegmentPropagation.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
public class ImpulsiveManeuverInformation : DefinitionalObject, 
	IThreadAware, ICloneWithContext

The ImpulsiveManeuverInformation type exposes the following members.

Constructors
  NameDescription
Public methodImpulsiveManeuverInformation
Initializes a new instance.
Protected methodImpulsiveManeuverInformation(ImpulsiveManeuverInformation, CopyContext)
Initializes a new instance as a copy of an existing instance.
Public methodImpulsiveManeuverInformation(String, Cartesian)
Initializes a new instance. Unless the FuelMassIdentification, DryMassIdentification and ExhaustVelocity properties are configured there will be no attempt to keep track of fuel usage at propagation time.
Public methodImpulsiveManeuverInformation(String, Cartesian, Axes)
Initializes a new instance. Unless the FuelMassIdentification, DryMassIdentification and ExhaustVelocity properties are configured there will be no attempt to keep track of fuel usage at propagation time.
Public methodImpulsiveManeuverInformation(String, Cartesian, String, String, Scalar, InvalidFuelStateBehavior)
Initializes a new instance.
Public methodImpulsiveManeuverInformation(String, Cartesian, Axes, String, String, Scalar, InvalidFuelStateBehavior)
Initializes a new instance.
Top
Properties
  NameDescription
Public propertyCostateElementIdentification

Gets or sets the identification of the optional costate vector element in the state passed into the ImpulsiveManeuverSegment. This should be the identification of a PropagationVector or a similarly configured custom type. The costate could represent a primer vector as introduced by D. F. Lawden in "Optimal Trajectories for Space Navigation", 1964.

If this is empty or , the CostateVector and InnerCostateParameter will not be available to the propagator generated by the ImpulsiveManeuverSegment.

Public propertyCostateVector
Gets the Vector that can optionally be used to construct geometry types (such as the Orientation) that represent the CostateElementIdentification at propagation time.
Public propertyDeltaV
Gets or sets the delta-V that will get applied to the PropagationElementIdentification.
Public propertyDryMassIdentification
Gets or sets the identification of the dry mass getting propagated.
Public propertyExhaustVelocity
Gets or sets the exhaust velocity in meters per second. If you have the specific impulse of your engine, you can compute the exhaust velocity by multiplying it by Earth's surface gravity, generally EarthSurfaceGravity.
Public propertyFuelMassIdentification
Gets or sets the identification of the fuel mass getting propagated.
Public propertyInnerCostateParameter
Gets or sets a second optional parameter that can be used to evaluate the Orientation and ExhaustVelocity.
Public propertyInnerParameter
Gets or sets the parameter used to evaluate the Orientation and ExhaustVelocity.
Public propertyInvalidFuelUseBehavior
Gets or sets a enum specifying what should be done if there is not enough fuel for the requested DeltaV.
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
Public propertyOrientation
Gets or sets the orientation of the engines that will apply the DeltaV. If your axes depends on the point being propagated, such as an AxesVelocityOrbitNormal, use the PropagationPoint in defining that Axes. If your axes depend on an optionally defined costate vector, use the CostateVector in defining that Axes.
Public propertyPropagationElementIdentification
Gets or sets the identification of the point element in the state passed into the ImpulsiveManeuverSegment that the DeltaV will be applied to. For a given ImpulsiveManeuverSegment, there may not be two maneuvers operating on the same propagation element.
Public propertyPropagationPoint
Gets the Point to use when constructing geometry types (such as the Orientation that represents the PropagationElementIdentification at propagation time.
Public propertyX
Gets or sets the X component of the DeltaV.
Public propertyY
Gets or sets the Y component of the DeltaV.
Public propertyZ
Gets or sets the Z component of the DeltaV.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides DefinitionalObjectCheckForSameDefinition(DefinitionalObject).)
Protected methodCheckForSameDefinition(ImpulsiveManeuverInformation)
Checks to determine if another instance has the same definition as this instance and returns if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CheckForSameDefinition(DefinitionalObject) method.
(Overrides DefinitionalObjectComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.
(Overrides DefinitionalObjectEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by Freeze to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.
(Inherited from DefinitionalObject.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also