Description
The RotatingLibrationPoint allows the user to set up a Rotating Libration Point coordinate system using either CelestialObject or CelestialSystem objects as the gravitational centers of the system for both usage and visualization. The states of spacecraft centered on L1-L5 points can be retrieved relative to the two centers.
Inheritance Hierarchy: ObjectàRotatingLibrationPoint
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Name
|
Description
|
Bodies
|
The CelestialObjects currently in the RotatingLibrationPoint system.
|
Color
|
The color of the visual representation point of the RotatingLibrationPoint object. The color can be overridden for an individual view using the ViewWindow.SetObjectColor() method.
|
DeclaredName
|
The name of the object as declared.
|
LibrationPoint
|
The libration point that this RotatingLibrationPoint object represents. The L1, L2, and L3 points are collinear, lying along the line joining the primary system (P1) and the secondary system (P2). The L4 and L5 points each form equilateral triangles with the positions of P1 and P2, in the plane of orbit.
|
MassRatio
|
The mass ratio of the Rotating Libration Point system. Depending on the value of the RecomputeBarycenter property, the mass ratio will be calculated two different ways:
If RecomputeBarycenter == 1, then the mass ratio is calculated as the ratio of the combined mass of all bodies in the secondary system to the total mass of all bodies in the system.
If RecomputeBarycenter == 0, then the mass ratio is calculated as the ratio of the combined mass of all bodies in the secondary system to the mass of all bodies in the primary system.
|
Name
|
The name displayed for this object in output windows such as views, plots, and reports.
|
ObjectId
|
The unique identifier for the object.
|
ObjectType
|
The type of the object.
|
PrimarySystem
|
The primary system (P1) of the libration point object.
|
RecomputeBarycenter
|
Flag indicating whether the barycenter will be computed using only the bodies in the primary system, or using all the bodies in the system. Note that the built-in planets (other than the Earth) represent the positions of their system barycenters. You can create a custom CelestialObject to represent the body center of any planet.
RecomputeBarycenter == 1 means that all the bodies in the system will be used to compute the system barycenter.
RecomputeBarycenter == 0 means that the primary system will be used as the system barycenter.
|
ReferenceBody
|
The reference body is used as the origin when computing the position and velocity of the RotatingLibrationPoint using the GetPositionAtEpoch, GetVelocityAtEpoch, and GetPosVelAtEpoch methods. Use the SetReferenceBody method to assign the ReferenceBody.
|
SecondarySystem
|
The secondary system (P2) of the libration point object.
|
SystemMass
|
The total mass of the RotatingLibrationPoint system.
|
SystemMu
|
The total Mu (sum of gravitational parameters of all bodies) of the RotatingLibrationPoint system.
|
VisualScale
|
The size at which to represent the RotatingLibrationPoint when viewed in a MissionView.
|
|
Name
|
Description
|
ClearSavedStates
|
Clears previous saved states for this object.
|
GetDCMAtEpoch
|
Returns the direction-cosine-matrix of the RotatingLibrationPoint, representing the instantaneous rotation from the MJ2000 Earth Equator Frame to the rotating frame.
|
GetFromFile
|
Load the object state from the specified FreeFlyer object file.
|
GetFromString
|
Load the object state from the specified string.
|
GetPositionAtEpoch
|
Returns the X, Y, Z components of the state of the RotatingLibrationPoint in the MJ2000 Earth Equator frame, using the ReferenceBody as the origin.
|
GetPositionOfObject
|
Returns an Array containing the position of the argument object relative to the RotatingLibrationPoint, expressed in the specified frame.
|
GetPosVelAtEpoch
|
Returns the X, Y, Z, VX, VY, VZ components of the state of the RotatingLibrationPoint, using the ReferenceBody as the origin.
|
GetPosVelOfObject
|
Returns an Array containing the position and velocity of the argument object relative to the RotatingLibrationPoint, expressed in the specified frame.
|
GetSpacecraftState
|
Gets the Spacecraft object's position and velocity at the Spacecraft's current epoch in the specified frame and with respect to the specified origin.
|
GetVelocityAtEpoch
|
Returns the VX, VY, VZ components of the state of the RotatingLibrationPoint, using the ReferenceBody as the origin.
|
GetVelocityOfObject
|
Returns an Array containing the velocity of the argument object relative to the RotatingLibrationPoint, expressed in the specified frame.
|
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.
|
SetPrimarySystem
|
Sets the primary system (P1) of the RotatingLibrationPoint object.
|
SetReferenceBody
|
Sets the CelestialObject to use as the origin when computing the position and velocity of the RotatingLibrationPoint using the GetPositionAtEpoch, GetVelocityAtEpoch, and GetPosVelAtEpoch methods.
|
SetSecondarySystem
|
Sets the secondary system (P2) of the RotatingLibrationPoint object.
|
SetSpacecraftState
|
Sets the Spacecraft object's position and velocity at the Spacecraft's current epoch given the state vector in the specified frame and with respect to the specified origin.
|
|
See also
Rotating Libration Points Guide
|
