RotatingPulsatingSystem Object

The RotatingPulsatingSystem allows the user to set up a rotating-pulsating coordinate system using either CelestialObject or Spacecraft objects as the primary and secondary bodies of the system. You can compute and assign Spacecraft object states in the rotating-pulsating frame.

Available In Editions:

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.

Name	Description	Attributes
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
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
PrimaryObject	The ObjectId of the Primary Object for the viewpoint.	Type: Object Access: Read-Only
Pulsating	Controls the pulsating behavior of this view. Setting the bool to true enables the pulsating behavior, while setting the bool to false disables the pulsating behavior.	Type: Variable Access: Read/Write
ReferenceDistance	The distance used as the reference distance between the Primary and Secondary Objects. This is used in establishing the frame and in calculating the scale factor. This value must be set before the Rotating Pulsating System can be used.	Type: Variable Access: Read/Write
ReferenceVector	The second vector used in establishing the frame. For a closed, bounded orbit (such as Earth-Moon), this should be the velocity vector of the Secondary Object. For alternately retro- and prograde motion (such as Earth-Mars), this should be a nearly constant vector, such as Mean of J000 Earth Ecliptic North.	Type: Variable Access: Read/Write
SecondaryObject	The ObjectId of the Secondary Object for the viewpoint.	Type: Object Access: Read-Only

Name	Description
ClearSavedStates	Clears previous saved states for this object.
GetDCMAtEpoch	Returns the direction-cosine-matrix of the RotatingPulsatingSystem, representing the instantaneous rotation from the ICRF to the rotating pulsating frame.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
GetPositionOfObject	Returns an Array containing the position of the argument object relative to the RotatingPulsatingSystem.
GetPosVelOfObject	Returns an Array containing the position and velocity of the argument object relative to the RotatingPulsatingSystem.
GetScaleFactor	Returns the scale factor for the transformation matrix at the specified epoch in km. The scaling factor is used to keep the position of the two objects constant in the frame, and is generally derived from the instantaneous distance between the two objects.
GetVelocityOfObject	Returns an Array containing the velocity of the argument object relative to the RotatingPulsatingSystem.
InitializeFromRotatingPulsatingViewpoint	Creates a new RotatingPulsatingSystem object using the viewpoint's objects and pulsating behavior.
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.
SetPrimaryObject	Sets the primary object of the RotatingPulsatingSystem object.
SetSecondaryObject	Sets the secondary object of the RotatingPulsatingSystem object.
SetSpacecraftState	Sets the Spacecraft object's position and velocity at the Spacecraft epoch given the state vector with respect to the RotatingPulsatingSystem.

RotatingPulsatingSystem Object

Description

Available In Editions:

Timing Precision Mode