CartesianOrbitStateEstimablePropertyContainer Object

 Top  Previous  Next

Description

The CartesianOrbitStateEstimablePropertyContainer object provides a collection of the Cartesian estimable properties for use when estimating the Spacecraft state in the Cartesian element set. This object is not creatable in script, but is always created as a child object of the SpacecraftODProperties object, as seen below:

 

Spacecraft1.OD.Cartesian.X.Sigma = 0.05;

 

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->CartesianOrbitStateEstimablePropertyContainer

Parent Object: SpacecraftODProperties

 

Available In Editions:

Engineer

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.

 

Properties

 

Name

Description

Attributes

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

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

Position

Array of the X, Y, and Z (positional) EstimableProperty objects.

Type:   Array of EstimablePosition

Access: Read-Only

PositionProcessAction

This flag is a shortcut to set all of the position (X,Y,Z) Process Action flags.

Type:   Variable

Access: Read/Write

ProcessAction

This flag is a shortcut to set all of the cartesian based position/velocity (X,Y,Z,VX,VY,VZ) Process Action flags.

Type:   Variable

Access: Write-Only

Properties

Array of all EstimableProperty objects included in the SpacecraftODProperties.Cartesian object.

Type:   Array of EstimableProperty

Access: Read-Only

Velocity

Array of the VX, VY, and VZ (velocity) EstimableProperty objects.

Type:   Array of EstimableVelocity

Access: Read-Only

VelocityProcessAction

This flag is a shortcut to set all of the velocity (VX,VY,VZ) Process Action flags.

Type:   Variable

Access: Read/Write

VX

The OD property that contains all of the OD statistics (Sigma, State Update, etc) associated with the Spacecraft.VX property.

Type:   EstimableVelocity

Access: Read-Only

VY

The OD property that contains all of the OD statistics (Sigma, State Update, etc) associated with the Spacecraft.VY property.

Type:   EstimableVelocity

Access: Read-Only

VZ

The OD property that contains all of the OD statistics (Sigma, State Update, etc) associated with the Spacecraft.VZ property.

Type:   EstimableVelocity

Access: Read-Only

X

The OD property that contains all of the OD statistics (Sigma, State Update, etc) associated with the Spacecraft.X property.

Type:   EstimablePosition

Access: Read-Only

Y

The OD property that contains all of the OD statistics (Sigma, State Update, etc) associated with the Spacecraft.Y property.

Type:   EstimablePosition

Access: Read-Only

Z

The OD property that contains all of the OD statistics (Sigma, State Update, etc) associated with the Spacecraft.Z property.

Type:   EstimablePosition

Access: Read-Only

 
 

 

Methods

 

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.