Description
The Star object stores the location of a star as a unit vector in the Mean of J2000 coordinate system.
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->Star
Parent Object: StarField
Available In Editions:
Engineer
Mission
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.
Click here to see the documentation for this object in nanosecond timing precision mode.
Name
|
Description
|
Attributes
|
Color
|
The color of star when viewed in a Mission View.
|
Type: Variable
Access: Read/Write
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
ID
|
Allows you to associate an identification number with the star.
|
Type: Variable
Access: Read/Write
|
Magnitude
|
Affects the size of the star point when viewed in a Mission View.
|
Type: Variable
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
|
Position
|
The vector pointing toward the star in the ICRF. Only the direction of this vector is used; the magnitude has no effect.
|
Type: Array
Access: Read/Write
|
StarName
|
The label shown with the star when viewed in a Mission View.
|
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.
|
|
Name
|
Description
|
Attributes
|
X
|
The X-component of the vector pointing toward the star in the ICRF. Only the direction of this vector is used; the magnitude has no effect.
This property has been Deprecated. Please use Position instead.
|
Type: Variable
Access: Read/Write
|
Y
|
The Y-component of the vector pointing toward the star in the ICRF. Only the direction of this vector is used; the magnitude has no effect.
This property has been Deprecated. Please use Position instead.
|
Type: Variable
Access: Read/Write
|
Z
|
The Z-component of the vector pointing toward the star in the ICRF. Only the direction of this vector is used; the magnitude has no effect.
This property has been Deprecated. Please use Position instead.
|
Type: Variable
Access: Read/Write
|
|
See also
Coverage and Contact Analysis Guide
Stars Guide
| 