Formation Object

Description

The Formation object is an extended List<Spacecraft> which provides additional visualization options.

Inheritance Hierarchy: Object->List<Object>->List<Spacecraft>->Formation

Available In Editions:

Engineer

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
Clear	Removes all elements from the List.
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.
LoadRinexNavFile	Populates a Formation with one Spacecraft for each SatelliteId in the specified Rinex Navigation file and then initializes the Spacecraft with that state. This method also attaches a sensor to each Spacecraft in the Formation.
LoadSP3Ephemeris	Populates a Formation with one Spacecraft for each SatelliteId in the specified SP3 Precise Ephemeris file and then initializes the Spacecraft with that state. This method also attaches a Sensor and GPS Receiver to each Spacecraft in the Formation.
LoadTLE	Adds a Formation Spacecraft for each state in the specified TLE file and then initializes the Spacecraft with that state. If you are loading a Spacecraft state from a TLE, you should use a SGP4 propagator when running your Mission Plan.
MaxEpoch	Returns the maximum epoch contained within the Formation.
MinEpoch	Returns the minimum epoch contained within the Formation.
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.
RemoveAt	Remove the object at the specific index.
ResetMethodStates	Resets any method states associated with the calling object.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.
SetRandomStates	Populates the Formation with states from a random Gaussian distribution described by the provided covariance matrix. The dimension and order of the covariance matrix is assumed to be consistent with the ProcessAction properties held in the first Spacecraft in the formation. The number of states generated is determined by the size of the provided Formation.
Step	Steps each Spacecraft in the Formation using the current propagator step size.
StepToEpoch	Steps each Spacecraft in the Formation to the specified epoch.