IonosphereOptions Object

 Top  Previous  Next

Description

The IonosphereOptions object is an internal object used to hold the different configurable properties of the ionosphere model that is used when processing observations in an Orbit Determination / State Estimation process.

 

Users cannot create instances of this type of object. However, users can access instances of this object type that have been created indirectly, for example as children of other objects. Users can also access any static properties and methods on this object type.

 

Inheritance Hierarchy: Object->IonosphereOptions

 

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.

 

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

IntegrationStepSize

The Step Size to use when integrating the Ionospheric Delay along the signal ray path. This is used when predicting Ionospheric biases for tracking data.

Type:   Variable

Access: Read/Write

Units:   km

MaximumHeight

The maximum geodetic height of the Ionosphere.

Type:   Variable

Access: Read/Write

Units:   km

MinimumHeight

The minimum geodetic height of the Ionosphere.

Type:   Variable

Access: Read/Write

Units:   km

Model

The Ionosphere model that is to be used.

Type:   Variable

Access: Read/Write

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

ScaleFactor

A multiplicative Scale Factor applied to all Ionospheric calculations, including Electron Density and Total Electron Content. A Scale Factor of two will double the values computed by the Ionosphere Model.

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.