Description
The SPKProperties object provides a collection of properties associated with writing SPICE SPK ephemeris files. This object is not creatable in script, but is always created as a child object of the Ephemeris object, as seen in the example below:
Ephemeris1.SPKProperties.SPKType = 13;
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->SPKProperties
Available In Editions:
Engineer
Mission
Timing Precision Mode
This page describes functionality in millisecond timing precision mode.
Click here to see the documentation for this object in nanosecond timing precision mode.
Name
|
Description
|
Attributes
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
MetadataComments
|
Descriptive information that could include: time of file creation, author of file, time coverage, ephemeris objects included, sources of the data used to produce this SPK file, cautions and restrictions on how the file is to be used.
|
Type: String
Access: Read/Write
|
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
|
ObserverNAIFID
|
The NAIF ID of the observer.
|
Type: Variable
Access: Read/Write
|
ObserverName
|
The name of observer.
|
Type: String
Access: Read/Write
|
PolynomialDegree
|
This is the degree of an interpolating polynomial. This is property is relevant when creating type 8, 9, 12, or 13 (Lagrange and hermite interpolation). For types 8 and 9 requires odd value, while types 12 and 13 must be 3-mod-4 (that is, 3, 7, 11, 15, 19, 23, 27).
|
Type: Variable
Access: Read/Write
|
SPKType
|
The SPK type that will be used to generate SPK files.
|
Type: Variable
Access: Read/Write
|
TargetNAIFID
|
The NAIF ID of the target.
|
Type: Variable
Access: Read/Write
|
TargetName
|
The name of target.
|
Type: String
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.
|
|
See also
Using a SPICE Ephemeris
|
