Description
The RampTableEntry object allows the user to configure the entries that make up the ramping schedule for a GroundAntenna.FrequencyRampingSchedule, which is used for processing DSN data. This object is not creatable in script, but an array of RampTableEntry objects is always created as a child object of the GroundAntenna.FrequencyRampingSchedule object as seen in the example below:
GroundStation1.Antenna.FrequencyRampingSchedule.Entries[0].FrequencyRate = 0.0; // Hz/second
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->RampTableEntry
Parent Object: FrequencyRampSchedule
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.
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
|
FrequencyRate
|
Rate of frequency change over the ramp interval.
|
Type: Variable
Access: Read/Write
Units: Hz/s
|
ObjectId
|
The unique identifier for the object.
|
Type: Variable
Access: Read-Only
|
ObjectType
|
The type of the object.
|
Type: String
Access: Read-Only
|
StartEpoch
|
The epoch at which that the frequency ramp starts.
|
Type: TimeSpan
Access: Read/Write
Units: day
|
StartFrequency
|
Starting frequency for the ramp interval.
|
Type: Variable
Access: Read/Write
Units: Hz
|
Type
|
Ramp interval type.
|
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.
|
|
|