GroundAntenna Object

The GroundAntenna object is used to define the characteristics of tracking data being provided from the ground station. See the Orbit Determination Guide for more information.

Available In Editions:

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.

Name	Description	Attributes
ApplyTrackingDataConstraintChecks	Specifies whether to apply range validation to measurements associated with the GroundAntenna.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
FrequencyRampingSchedule	This property contains the frequency ramping information to be used for processing DSN data.	Type: FrequencyRampSchedule Access: Read/Write
ID	The ID used to associate tracking measurements with this antenna.	Type: String Access: Read/Write
LimbLimit	The elevation angle dictating whether a whole observation is determined to be valid or not. Whole observations with an elevation less than this limit are marked as invalid.	Type: Variable Access: Read/Write Units: deg
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
ObjectType	The type of the object.	Type: String Access: Read-Only
OD	This property contains the OD settings for all the GroundAntenna properties that can be estimated.	Type: GroundAntennaODProperties Access: Read-Only
RangeRateAveragingInterval	The time interval over which the Range-Rate measurements are averaged. When using instantaneous data, this interval should be set to 1 millisecond.	Type: Variable Access: Read/Write Units: s
ReceiveFrequency	The antenna downlink frequency. Note: This property is needed only if the antenna object is used for Orbit Determination and the associated tracking data file(s) are of type ASCII format. For UTDF and DSN tracking formats, this property holds the value of the transmit/receive frequency as obtained from the tracking data file during execution of the Orbit Determination object.	Type: Variable Access: Read/Write Units: Hz
TransmitFrequency	The antenna uplink frequency. Note: This property is needed only if the antenna object is used for Orbit Determination and the associated tracking data file(s) are of type ASCII format. For UTDF and DSN tracking formats, this property holds the value of the transmit/receive frequency as obtained from the tracking data file during execution of the Orbit Determination object.	Type: Variable Access: Read/Write Units: Hz
UseLimbLimit	Flag indicating whether or not to mark the observation invalid, based on the elevation of the observation. If the elevation is not in use, then this setting is ignored.	Type: Variable Access: Read/Write
UseRampingData	Use ramping data to determine the time-varying frequency over the duration of the transmission for DSN contacts.	Type: Variable Access: Read/Write

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.

Name

Description

Attributes

EarthLimbLimit

Deprecated synonym for LimbLimit. The elevation angle dictating whether a whole observation is determined to be valid or not. Whole observations with an elevation less than this limit are marked as invalid.

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

Type: Variable

Access: Read/Write

Units: deg

UseEarthLimbLimit

Deprecated synonym for UseLimbLimit. Flag indicating whether or not to mark the observation invalid, based on the elevation of the observation. If the elevation is not in use, then this setting is ignored.

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

Type: Variable

Access: Read/Write