EphemerisVector Object

 Top  Previous  Next

Description

The EphemerisVector object enables a user to conveniently handle a row in an Ephemeris object and manipulate values in that row of varying types, including String objects, Variable objects, and TimeSpan objects. You can assign EphemerisVector objects using the = operator.

 

Inheritance Hierarchy: Object->EphemerisVector

 

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.

 

Constructors

 

Signatures

Description

EphemerisVector()

Create an EphemerisVector.

EphemerisVector(Ephemeris ephemeris)

Create an EphemerisVector while associating it to an ephemeris to use for initializing columns.

 

 

 

Properties

 

Name

Description

Attributes

ColumnDataTypes

The data types for the columns in the EphemerisVector. Note, this property is not populated until a call to InitializeColumns is made.

Type:   Array

Access: Read-Only

ColumnNames

Names of the columns in the EphemerisVector. Note, this property is not populated until a call to InitializeColumns is made.

Type:   StringArray

Access: Read-Only

Comment

Comment associated with the vector

Type:   String

Access: Read/Write

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

Epoch

The epoch of the vector in the ephemeris.

Type:   Variable

Access: Read/Write

Units:   day

Name

The name displayed for this object in output windows such as views, plots, and reports.

Type:   String

Access: Read/Write

NumberOfColumns

Number of columns in the vector.

Type:   Variable

Access: Read-Only

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

 
 

 

Methods

 

Name

Description

AddColumn

Adds a new column to the EphemerisVector.

AddColumns

Adds multiple new columns to the EphemerisVector.

ClearSavedStates

Clears previous saved states for this object.

GetColumnsWithDiscontinuities

Retrieves the indices of any columns containing a discontinuity.

GetFromFile

Load the object state from the specified FreeFlyer object file.

GetFromString

Load the object state from the specified string.

GetStringValue

Gets the specified column value as a string.

GetStringValues

Gets the specified columns as strings.

GetVariableValue

Gets the specified column value as a float.

GetVariableValues

Gets the specified columns as floats.

HasDiscontinuities

Returns whether or not the vector contains 1 or more discontinuities in the vector.

InitializeColumns

Initializes the EphemerisVector object with the columns available in the specified Ephemeris. This method should be called prior to setting data into an Ephemeris.

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.

RemoveAllColumns

Removes all columns from the EphemerisVector.

RemoveColumn

Removes a column from the EphemerisVector.

Restore

Restore an object's state from a previously saved state.

Save

Save the object's state so that it can be restored later.

SetStringValue

Sets the specified column to the provided value as a string.

SetStringValues

Sets the specified columns to the provided values as strings.

SetVariableValue

Sets the specified column to the provided value as a float.

SetVariableValues

Sets the specified columns to the provided values as floats.

 
 

 

 

See also

Working with Ephemerides