SpiceFileReader Object

 Top  Previous  Next

Description

The SpiceFileReader object is used to gather data from a SpiceEphemeris object.

 

Inheritance Hierarchy: Object->SpiceFileReader

 

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.

 

Properties

 

Name

Description

Attributes

CalculateOrientation

Flag indicating whether or not to calculate the orientation of the Target body.

Type:   Variable

Access: Read/Write

CurrentAngularVelocity

The angular velocity associated with the specified object at the CurrentEpoch.

Type:   Array

Access: Read/Write

CurrentEpoch

The epoch at which the position and velocity should be evaluated for the SPICE ephemeris.

Type:   Variable

Access: Read/Write

Units:   day

CurrentOrientation

The orientation, in quaternion form, associated with the specified object at the CurrentEpoch.

Type:   Array

Access: Read/Write

CurrentPosition

The position associated with the specified object at the CurrentEpoch.

Type:   Array

Access: Read/Write

Units:   km

CurrentVelocity

The velocity associated with the specified object at the CurrentEpoch.

Type:   Array

Access: Read/Write

Units:   km/s

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

Filename

The name of the spice file to read.

Type:   String

Access: Read/Write

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

Objects

This property is not supported at this time.

Type:   StringArray

Access: Read/Write

ObjectType

The type of the object.

Type:   String

Access: Read-Only

Observer

The name of the observer object. This is the object which defines the origin of the retrieved state.

Type:   String

Access: Read/Write

ObserverNAIFID

NAIF ID of the Observer object.

Type:   Variable

Access: Read/Write

Parse

Method to force the SPICE file to be read.

Type:   Variable

Access: Read/Write

Reset

Method to reset the SPICE library.

Type:   Variable

Access: Read/Write

Target

The name of the target object, the object whose state is evaluated with respect to the Observer.

Type:   String

Access: Read/Write

TargetNAIFID

NAIF ID of the Target object.

Type:   Variable

Access: Read/Write

 
 

 

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.

 
 

 

Deprecated Properties

 

Name

Description

Attributes

FileName

The name of the spice file to read.

 

This property has been Deprecated. Please use Filename instead.

Type:   String

Access: Read/Write