Chains and Constellations
There are a number of commands that allow you to control the definition and graphical display of chain and constellation objects. For most commands associated with these objects, the actual command name is Chains. The generic structure of most Chains commands is:
Chains <ObjectPath> {ChainsOption} <Parameters>
or for commands that return information:
Chains_R <ObjectPath> {ChainsOption} <Parameters>
In either case, the {ChainsOption} indicates the action being executed by the command, and will change depending on the action you wish to take. Additional <Parameters> may be required depending on the {ChainsOption} specified.
If you use the Unload command to remove an object that is used by more than one chain or constellation, calculations to the other object will be affected.
| Command | Format | Description | Version |
|---|---|---|---|
| CentralBody_R | CentralBody_R <ApplicationPath> <ObjectPath> | Returns the name of the central body of any object | 10.0.2 |
| Chain Processing Delay | ChainProcessingDelay <ObjectPath> {Option} [<Parameters>] | Set the processing delay for an object. | 12.8 |
| Chains | Chains <ObjectPath> {ChainOption} [<Parameters>] | Configure a chain object or computes access for a chain | 12.8 |
| Chains_R | Chains_R <ObjectPath> {ChainsOption} | Return information about a Chain. | 11.4 |
| Chains_RM Access | Chains_RM <ApplicationPath> Access {AccessType} | Calculate various access data within and outside of a chain | 4.1.1 |
| Constellation | Constellation <ObjectPath> {Option} [<Parameters>] | Add or remove a subobject of constellation and set routing file information | 12.8 |
| Constellation_R | Constellation_R <ObjectPath> {ConstellationOption} | Return information about a Constellation. | 12.8 |
| Copy | Copy <ApplicationPath> <CopyFromObjectPath> [{CopyOption}] | Copy and paste an object. | 8.0 |
| ExternalData | ExternalData <ObjectPath> {DataOption} [<Parameters>] | Allow for the association and management of time ordered data computed outside of STK with STK objects. | 10 |
| GetDescription | GetDescription <ObjectPath> {Type} | Return the description of an object | 4.0.6 |
| Graphics (Chains & Constellations) | Graphics <ObjectPath> {ChainGfxOption} [<Parameters>] | Set the graphics properties for chains and constellations | 12.8 |
| Graphics Marker | Graphics <ObjectPath> Marker {MarkerType} ["<FilePath>" [{CustomOptions}]] | Define a marker to represent an object in a 2D Graphics window | 11.6 |
| Graphics Show | Graphics <ObjectPath> Show {On | Off} | To turn on or off the graphics display of an object. | 10 |
| Load | Load <ApplicationPath> {<ClassPath> | VDF} "<FilePath>" | Open an existing scenario or insert an object into the current scenario | 8.0 |
| New | New <ApplicationPath> <ClassPath> <NewObjectName> {NewOptions} | Create a new scenario or add a new object to the current scenario | 8.1 |
| NewMulti | NewMulti <ApplicationPath> <ClassPathOfObjectToCreate> <NumToCreate> <NewName1> [<NewName2>...] [NoDefault] [Ignore] | Create multiple instances of new objects | 4.2 |
| Rename | Rename <ObjectPath> <NewName> | Rename an object | 4.0 |
| Save | Save <ApplicationPath> <ObjectPath> ["<SaveInDirectory>"] | Save a scenario or object within a scenario | 4.0 |
| SaveAs | SaveAs <ApplicationPath> <ObjectPath> "<FilePath>" | Save a scenario or object within a scenario with a different name | 4.2 |
| SetAsDefault | SetAsDefault <ApplicationPath> [<ObjectPath>] | Save the indicated object as the default | 4.2 |
| SetConstraint (Chain or Constellation) | SetConstraint <ObjectPath> {ConstraintName} {Parameters} | Set a constraint for a chain or constellation | 11.6 |
| SetConstraintOptions | SetConstraintOptions <ObjectPath> {ConstraintName} {Options} | Set constraint options for an object's active constraints. | 9.2.2 |
| SetDescription | SetDescription <ObjectPath> {Type} [{Option}] "<Description>" | Set the long or short description of a scenario or object | 6.2 |
| TimeTool | TimeTool <ScenarioPath> {Options} | Define components defining instances or intervals of time. | 11.5 |
| TimeTool Interval | TimeTool <ScenarioPath> <ParentObject> {Action} {"Interval" | "IntervalTemplate"} <ComponentName> [{IntervalType} <TypeParams>] | Define and modify Interval components and templates. | 11.3 |
| TimeTool Interval List | TimeTool <ScenarioPath> <ParentObject> {Action} {"Interval List" | "Interval ListTemplate"} <ComponentName> [{IntervalListType} <TypeParams>] | Define and modify Interval List components and templates. | 11.5 |
| TimeTool Time Array | TimeTool <ScenarioPath> <ParentObject> {Action} {"Time Array" | "Time ArrayTemplate"} <ComponentName> [{TimeArrayType} <TypeParams>] | Define and modify Time Array components and templates. | 11.7.1 |
| TimeTool Time Instant | TimeTool <ScenarioPath> <ParentObject> {Action} {"Time Instant" | "Time InstantTemplate"} <ComponentName> [{TimeInstantType} <TypeParams>] | Define and modify Time Instant components and templates. | 10 |
| TimeTool_R | TimeTool_R <ScenarioPath> {Option} [<Parameters>] | Return information about TimeTool components. | 10 |
| TimeTool_RM | TimeTool_RM <ScenarioPath> {Option} [<Parameters>] | Return information about TimeTool components. | 10.1 |
| Unload | Unload <ApplicationPath> <ObjectPath> [RemAssignedObjs] | Remove an object or scenario | 4.0 |
| UnloadMulti | UnloadMulti <ApplicationPath> <ObjectPath> | Remove an object and all of its subobjects from the current scenario | 9.1 |