GPSPivotPointSolutionFile Object

 Top  Previous  Next

Description

The GPSPivotPointSolutionFile object provides functionalities for reading and writing GPS Pivot Point Solution files.  This is an ASCII file of Point Solution data as put out by the Pivot GPS receiver. The time system is TAI, and position and velocity values are given in meters and m/s in ICRF.  

 

Inheritance Hierarchy: Object->TrackingDataFile->PointSolutionFile->GPSPivotPointSolutionFile

 

Available In Editions:

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

GPSPivotPointSolutionFile()

Create a GPSPivotPointSolutionFile object without associating the contained Observations with any other objects.

GPSPivotPointSolutionFile(GPSReceiver receiver)

Create a GPSPivotPointSolutionFile object, and associate the contained Observations with "receiver".

GPSPivotPointSolutionFile(String fileName)

Create a GPSPivotPointSolutionFile object and read Observation data from the file provided..

GPSPivotPointSolutionFile(GPSReceiver receiver, Sensor measuringSensor)

Create a GPSPivotPointSolutionFile object, and associate the contained Observations with "receiver" and "measuringSensor".

GPSPivotPointSolutionFile(String fileName, GPSReceiver receiver)

Create a GPSPivotPointSolutionFile object, read Observation data from the file provided, and associate the contained Observations with "receiver".

GPSPivotPointSolutionFile(String fileName, GPSReceiver receiver, Sensor measuringSensor)

Create a GPSPivotPointSolutionFile object, read Observation data from the file provided, and associate the contained Observations with "receiver" and "measuringSensor".

 

 

 

Properties

 

Name

Description

Attributes

DataSpanEndEpoch

The Epoch of the last Observation in the file.

Type:   Variable

Access: Read-Only

Units:   day

DataSpanStartEpoch

The Epoch of the first Observation in the file.

Type:   Variable

Access: Read-Only

Units:   day

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

Filename

The file name to load.

Type:   String

Access: Read/Write

FirstObservation

The first Observation in the file.

Type:   Observation

Access: Read-Only

LastObservation

The last Observation in the file.

Type:   Observation

Access: Read-Only

MeasuringReceiver

The GNSS Receiver taking the Point Solution Observations.

Type:   Receiver

Access: Read-Only

MeasuringSensor

The Sensor object attached to the measuring GNSSReceiver. The Sensor's X, Y, and Z position properties will be used to model an offset from the origin of the Spacecraft BCS when modeling measurements.

Type:   Sensor

Access: Read-Only

Name

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

Type:   String

Access: Read/Write

ObjectBeingObserved

The Spacecraft to which the observing GNSS Receiver is attached.

Type:   Spacecraft

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

UseVX

A flag indicating whether or not the X velocity measurement will be used.

Type:   Variable

Access: Read/Write

UseVY

A flag indicating whether or not the Y velocity measurement will be used.

Type:   Variable

Access: Read/Write

UseVZ

A flag indicating whether or not the Z velocity measurement will be used.

Type:   Variable

Access: Read/Write

UseX

A flag indicating whether or not the X position measurement will be used.

Type:   Variable

Access: Read/Write

UseY

A flag indicating whether or not the Y position measurement will be used.

Type:   Variable

Access: Read/Write

UseZ

A flag indicating whether or not the Z position measurement will be used.

Type:   Variable

Access: Read/Write

 
 

 

Methods

 

Name

Description

ClearSavedStates

Clears previous saved states for this object.

GetAllObservations

Retrieves all observations from the TrackingDataFile and stores them in a List<Observation>. Any current observations held by the OD Observation object will be overwritten by the GetAllObservations() method.

GetFromFile

Load the object state from the specified FreeFlyer object file.

GetFromString

Load the object state from the specified string.

GetNextObservation

Retrieves the next observation in file.

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.

ResetToStart

Resets the TrackingDataFile to the start of the file.

Restore

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

Save

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

SetMeasuringReceiver

Set the GNSS Receiver that is providing the observations.

WriteValidDataToFile

Write out all Observations containing valid Measurements to a file. Returns 1 if data was written to a file, 0 if no valid observation data was found, or if the method fails to write to a file.

 
 

 

Deprecated Properties

 

Name

Description

Attributes

ApplyLimitValidationChecks

Determines whether to set the Validity flag on measurements as they are loaded, based on the applicable limits for the particular measurement type.

 

This property has been Deprecated. Please use GroundAntenna.ApplyTrackingDataConstraintChecks instead.

Type:   Variable

Access: Read/Write

 
 

 

 

See also

Orbit Determination Guide

Tracking Data File Formats