Description
The PhaseControlModel object allows users access to setting the ControlType used by the TrajectoryPhase. FreeFlyer currently supports three control models: ballistic (no control), simple thruster, and ideal solar sail. All control models and their associated variables are formulated in the MJ2000 Earth Equator coordinate frame.
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->PhaseControlModel
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
|
ControlType
|
The type of control used by the ControlModel. All control models and their associated variables are formulated in the MJ2000 Earth Equator coordinate frame.
Warning: assigning a new value to this property will erase the existing control variables in the TrajectoryPhase and replace them with default values for the chosen control type.
|
Type: Variable
Access: Read/Write
|
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
|
IdealSolarSailOptions
|
Options for the Ideal Solar Sail control type.
|
Type: PhaseIdealSolarSailOptions
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
|
ShadowingBodies
|
The shadowing bodies used for the control model. TrajectoryPhase shadow calculations use a spherical body assumption and do not account for body flattening. When shadowing bodies are present and the 'ControlModel.ControlType' is set to 'SimpleThruster', a constraint will be applied that prevents the thrust when the path of the TrajectoryPhase is shadowed by at least one shadowing body. When shadowing bodies are present and the 'ControlModel.ControlType' property is set to 'IdealSolarSail', no thrust will be produced when the path of the TrajectoryPhase is shadowed by at least one shadowing body.
|
Type: Array of CelestialObject
Access: Read-Only
|
SimpleThrusterOptions
|
Options for the Simple Thruster control type.
|
Type: PhaseSimpleThrusterOptions
Access: Read-Only
|
|
Name
|
Description
|
AddShadowingBody
|
Adds a shadowing body to the ControlModel. TrajectoryPhase shadow calculations use a spherical body assumption and do not account for body flattening. When shadowing bodies are present and the 'ControlModel.ControlType' is set to 'SimpleThruster', a constraint will be applied that prevents the thrust when the path of the TrajectoryPhase is shadowed by at least one shadowing body. When shadowing bodies are present and the 'ControlModel.ControlType' property is set to 'IdealSolarSail', no thrust will be produced when the path of the TrajectoryPhase is shadowed by at least one shadowing body.
|
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.
|
RemoveAllShadowingBodies
|
Removes all shadowing bodies from the ControlModel.
|
RemoveShadowingBody
|
Removes a shadowing body from the ControlModel.
|
Restore
|
Restore an object's state from a previously saved state.
|
Save
|
Save the object's state so that it can be restored later.
|
|
|
