Description
The PhaseIntegrationOptions object defines the numerical integration settings used by a TrajectoryPhase to enforce system dynamics. It contains an Integrator child object whose force model is shared with the TrajectoryPhase.CollocationOptions.ForceModel property. Users can configure the integration method by calling SetIntegratorType(), while preserving existing force model settings and fixed-step values.
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->PhaseIntegrationOptions
Parent Object: TrajectoryPhase
Available In Editions:
Mission
Timing Precision Mode
This page describes functionality in nanosecond timing precision mode.
Click here to see the documentation for this object in millisecond timing precision mode.
Name
|
Description
|
Attributes
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DisplayName
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
Integrator
|
The Integrator used by the TrajectoryPhase to enforce the system dynamics. Modifying the ForceModel of this Integrator will also modify the TrajectoryPhase.CollocationOptions.ForceModel property. Note that the Integrator.FixedStep property for this instance of the Integrator type defaults to 0 (off).
|
Type: Integrator
Access: Read-Only
|
ObjectId
|
The unique identifier for the object.
|
Type: Variable
Access: Read-Only
|
ObjectType
|
The type of the object.
|
Type: String
Access: Read-Only
|
|
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.
|
SetIntegratorType
|
Sets the integrator type that the TrajectoryPhase will use. The Integrator.ForceModel characteristics will be preserved, as will the value of Integrator.FixedStep.
|
|
| 