Description
The Burn object is a base type that provides attitude, maneuver, scale factor, and burn component properties to the objects that derive from it. See the Maneuvering Guide for more information.
Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.
Inheritance Hierarchy: Object->ThrustEvent->Burn
Derived Types: FiniteBurn, ImpulsiveBurn
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.
Click here to see the documentation for this object in nanosecond timing precision mode.
Name
|
Description
|
Attributes
|
AttitudeSystem
|
Flag denoting the attitude frame in which the thrust event will be applied to the spacecraft.
|
Type: Variable
Access: Read/Write
|
BurnDirection
|
The components of the thrust vector in the coordinates of the attitude system specified by the chosen AttitudeSystem.
|
Type: Array
Access: Read/Write
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
ExecutionPhase
|
Reveals which portion of the event sequence is currently executing.
|
Type: Variable
Access: Read-Only
|
ManeuverOffsetTime
|
The offset time from current Spacecraft epoch, to apply the maneuver. The Spacecraft will be propagated to the offset time using the applicable ForceModel and Propagator properties. A negative offset time can be used.
|
Type: Variable
Access: Read/Write
Units: s
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
ObjectId
|
The unique identifier for the object.
|
Type: Variable
Access: Read-Only
|
ObjectType
|
The type of the object.
|
Type: String
Access: Read-Only
|
ThrustScaleFactor
|
The overall thrust scale factor for the maneuver.
|
Type: Variable
Access: Read/Write
|
|
Name
|
Description
|
ClearSavedStates
|
Clears previous saved states for this object.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
PutToFile
|
Convert the object state to FreeFlyer object xml and write to a file.
|
PutToString
|
Convert the object state to FreeFlyer object xml and return as a string.
|
ReferenceEquals
|
Returns 1 if the argument refers to the calling object and 0 otherwise.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
|
Name
|
Description
|
Attributes
|
ManeuverStartTime
|
The offset time from current Spacecraft epoch, to apply the maneuver. The Spacecraft will be propagated to the offset time using the applicable ForceModel and Propagator properties. A negative offset time can be used.
This property has been Deprecated. Please use ManeuverOffsetTime instead.
|
Type: Variable
Access: Read/Write
Units: s
|
X_Component
|
The x component of the force.
This property has been Deprecated. Please use the BurnDirection vector property instead.
|
Type: Variable
Access: Read/Write
|
Y_Component
|
The y component of the force.
This property has been Deprecated. Please use the BurnDirection vector property instead.
|
Type: Variable
Access: Read/Write
|
Z_Component
|
The z component of the force.
This property has been Deprecated. Please use the BurnDirection vector property instead.
|
Type: Variable
Access: Read/Write
|
|
See also
Impulsive Burns Guide
Finite Burns Guide
Outgassing Events Guide
| 