Description
The PhaseIdealSolarSailOptions object allows users to edit sail parameters such as Area and EfficiencyFactor for use with a TrajectoryPhase configured with an 'Ideal Sail' control type.
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->PhaseIdealSolarSailOptions
Parent Object: PhaseControlModel
Available In Editions:
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
|
ApplyNormConstraint
|
Whether to constrain the norm of the cartesian control variable vector to be equal to 1.
Warning: Setting this property to false (0) will often result in an ill-conditioned and/or non-physical problem unless the control variables are constrained directly by the user to have a cartesian norm equal to 1.
|
Type: Variable
Access: Read/Write
|
ApplySunPointingConstraint
|
Whether to constrain the cartesian control variable vector to never point towards the sun. In other words, the dot product of the cartesian control variable vector and the position vector with respect to the sun will be constrained to be greater than or equal to 0.
Warning: Setting this property to false (0) will often result in a non-physical problem unless the cartesian control variable vector is constrained directly by the user to never point towards the sun.
|
Type: Variable
Access: Read/Write
|
Area
|
The sail area in square meters.
|
Type: Variable
Access: Read/Write
Units: m^2
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
EfficiencyFactor
|
The reflective efficiency of the sail. This property directly scales the force produced by the sail.
|
Type: Variable
Access: Read/Write
|
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
|
|
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.
|
|
| 