BroadcastEphemeris Object

 Top  Previous  Next

Description

The BroadcastEphemeris object provides a FreeFlyer propagator type that makes use of a RINEX Navigation file (broadcast ephemeris) as the motion model.

 

Inheritance Hierarchy: Object->Propagator->BroadcastEphemeris

 

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.

 

Constructors

 

Signatures

Description

BroadcastEphemeris(RinexNavFile navFile, Variable id_number)

Create a BroadcastEphemeris propagator using the specified RinexNavFile and numeric ID code. When no GNSS constellation is specified, GPS is assumed.

BroadcastEphemeris(RinexNavFile navFile, Variable id_number, String gnssConstellation)

Create a BroadcastEphemeris propagator using the specified RinexNavFile and GNSS constellation string and numeric ID code.

 

 

 

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

Filename

The filename of the Broadcast Ephemeris file.

Type:   String

Access: Read-Only

FinalTOE

The Time Of Ephemeris (TOE) of the final ephem in the Broadcast Ephemeris propagator.

Type:   TimeSpan

Access: Read-Only

Units:   day

InitialTOE

The Time Of Ephemeris (TOE) of the first ephem in the Broadcast Ephemeris propagator.

Type:   TimeSpan

Access: Read-Only

Units:   day

NumberOfEphems

The number of Ephems contained in the Broadcast Ephemeris propagator.

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

StepSize

The number of seconds the propagated object is advanced when the Step command is executed.

Type:   TimeSpan

Access: Read/Write

Units:   s

 
 

 

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 file name of the Broadcast Ephemeris file.

 

This property has been Deprecated. Please use Filename instead.

Type:   String

Access: Read-Only

 
 

 

 

See also

Orbit Determination Guide

Broadcast Ephemeris Guide