FFEphemProperties.AddColumn(String, Variable, String, Variable, Variable) Method

Top 

Description

Adds a new column to the ephemeris with the specified column label that will be interpolated using the specified interpolator and with 'spacecraftProperty' as the associated mapped Spacecraft object matrix property with first index 'firstIndex' and second index 'secondIndex'.

 

If mapping a 'spacecraftProperty' representing an orbital element, use caution in mapping orbital elements from different element sets into one Ephemeris object; doing so may cause unexpected behavior when propagating the Spacecraft. For example, if the Keplerian true anomaly is mapped to the ephemeris along with the Cartesian position and velocity, the Keplerian true anomaly will be written into the Spacecraft after the position and velocity elements. In this particular case, writing the Keplerian true anomaly may adjust the Spacecraft's position and velocity, resulting in a slightly different state than the original position and velocity.

 

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.

 

Method Signature

FFEphemProperties.AddColumn(

String columnLabel,


Variable interpolator,


String spacecraftProperty,


Variable firstIndex,


Variable secondIndex)

 

 

Arguments

columnLabel


Description:

The label that will be used for the newly added column.

 

 

interpolator


Description:

The interpolator that will be used when interpolation is called for on the newly added column.

Valid Values:

Value

Label

0

5th Order Spline

1

8th Order Lagrange

2

10th Order Lagrange

3

0th Order Interpolation

 

 

 

spacecraftProperty


Description:

The writeable Spacecraft property that the information will be put into when the ephemeris containing the new column is used as a propagator for a Spacecraft. Furthermore, this Spacecraft property will be automatically written to the ephemeris when the Put command is called.

 

 

firstIndex


Description:

The first element for the mapped property, used only if the property is an array or matrix property of the Spacecraft object.

Valid Range:

firstIndex ≥ 0

 

 

secondIndex


Description:

The second element for the mapped property, used only if the property is a matrix property of the Spacecraft object.

Valid Range:

secondIndex ≥ 0

 

 

 

Return Value

Type:

number

 

 

Returns the number of columns in the ephemeris after the new column is added.

 

Syntax

myVariable1 = myFFEphemProperties1.AddColumn(myString1, myVariable2, myString2, myVariable3, myVariable4);

 

 

See also

FFEphemProperties Object

FFEphemProperties.AddColumn

Working with Ephemerides