Define and modify Axes geometry components and templates.
VectorTool <ScenarioPath> <ParentObject> {Action} {Axes | AxesTemplate} <AxesName> [{AxesType} <AxesTypeParams>]
The VectorTool Axes command is used to add, modify and delete Axes geometry components and templates.
For a component object the <ParentObject> is a truncated object path or a Central Body path.
For a template the <ParentObject> is an STK class name, and the AxesTemplate keyword must be entered.
The following table provides a description of {Action} values and the applicable parameters:
| {Action} | Parameters | Description |
|---|---|---|
| Create | {AxesType} [<AxesTypeParams>] | <AxesTypeParams> are optional, except where noted below. If no <AxesTypeParams> are specified, default values are used. |
| Modify | {AxesType} <AxesTypeParams> | The values <AxesName> {AxesType} must define an existing Axes component or template. The {AxesType} can not be modified. <AxesTypeParams> are required. |
| Delete | N/A | Delete the component or template identified by <AxesName> |
The following table describes each Axes type and it's parameters. Labels for the X, Y and Z axis can be optionally be entered for all Axes types.
| {AxesType} | <AxesParams> |
|---|---|
| "Aligned and Constrained" | {AlignVector_OrientMethod}
<AlignVector_OrientParameters> "<AlignVector>"
{ConstrainVector_OrientMethod}
<ConstrainVector_OrientParameters> "<ConstrainVector>"
["<XLabel>" "<YLabel>" "<ZLabel>"]
Valid values for {OrientMethod} <OrientParameters> are described below this table. |
| "Angular Offset" |
Any or all of the following keyword-value pairs can be specified:
Offset <Value> is entered in degrees and must be between -360.0 and 360.0 degrees. The default value is 0 degrees. |
| "B-Plane" | <CentralBodyName>
"<TrajectoryPoint>" "<ReferenceVector>" {Incoming |
Outgoing} ["<XLabel>" "<YLabel>" "<ZLabel>"]
Note: The <ParentObject> for the "B-Plane" Axes must be a Satellite. |
| "Custom Script" | {Reload | "<ReferenceAxes>"
"<FilePath>" [{InvalidOnExec}] ["<XLabel>"
"<YLabel>" "<ZLabel>"]}
"<FilePath>" can be a .m, .pl, .vbs or .dll (PC only) file. The "<FilePath>" value should include a full path. Custom Script files must be located in a hierarchy of pre-determined directories. For more information see Plugin Script Reference Note: "<ReferenceAxes>" "<FilePath>" parameters are required when Creating the "Custom Script" Axes Reload is valid for the Modify command only. The option {InvalidOnExec} is deprecated in STK 10, it should not be entered. |
| "File" | {"<FilePath>" | Reload}
[StartTime {TimeInstant}] [OverrideStartTime {Yes | No}]
["<XLabel>" "<YLabel>" "<ZLabel>"]
"<FilePath>" is an STK attitude file (*.a) Reload is valid for the Modify command only. Note: Either "<FilePath>" or Reload must be entered on each Axes "File" command. For valid {TimeInstant} values see Time Options. Sending StartTime {TimeInstant} will turn on the OverrideStartTime option. |
| "Fixed at Epoch" | "<EpochDate>"
"<SourceAxes>" ["<ReferenceAxes>"] ["<XLabel>"
"<YLabel>" "<ZLabel>"]
"<EpochDate>" is entered in Connect date units. |
| "Fixed at Time Instant" |
Any or all of the following keyword-value pairs can be specified:
|
| "Fixed in Axes" | {OrientMethod} <OrientParameters>
"<ReferenceAxes>" ["<XLabel>" "<YLabel>"
"<ZLabel>"]
Valid values for {OrientMethod} <OrientParameters> are described below this table. |
| "Libration" | <CentralBodyName> {L1 | L2 | L3 |
L4 | L5} <SecondaryBody> [<SecondaryBody>...]
["<XLabel>" "<YLabel>" "<ZLabel>"]
As many <SecondaryBody> as needed can be entered on the command line. Note: The <ParentObject> for the "Libration" Axes must be a CentralBody |
| "Model Attachment" | "<MdlAttachPoint>"
A valid <MdlAttachPoint> is determined by the attach points specified in the parent object's model file. Note: "<MdlAttachPoint>" is a required parameter for Create and Modify. Note: The <ParentObject> for the "Model Attachment" Axes must be an object for which a model is valid, Satellite, Facility, etc. Note: The "Model Attachment" Axes type is not valid for Templates. |
| "Plugin" |
The Reset parameter is valid for a Modify command only. Note: The PluginName "<PluginName>" parameter is required when Creating the "Plugin" Axes Note: The "Plugin" Axes type is not valid for Templates. |
| "Spinning" |
Any or all of the following keyword-value pairs can be specified:
"<Epoch>" is entered in Connect Date units. The default value is the object's start time. Offset <Value> is entered in degrees and must be between -360.0 and 360.0 degrees. The default value is 0 degrees. RotationRate <Value> is entered in Degrees/ConnectTimeUnit. The default value is 1.0 degree/second. |
| "Surface" | <CentralBodyName> "<Point>" [{UseMSLOn | UseMSLOff}] ["<XLabel>" "<YLabel>" "<ZLabel>"] |
| "Trajectory" | "<TrajectoryPoint>" "<ReferenceSystem>" {ICR | VNC | RIC | LVLH | VVLH | BBR} ["<XLabel>" "<YLabel>" "<ZLabel>"] |
| {AxesType} | {OrientMethod} | <OrientParams> |
|---|---|---|
| "Fixed in Axes" | Quat | <Q1> <Q2> <Q3> <Q4> |
| Euler | <EulerA> <EulerB>
<EulerC> <Sequence>
<EulerA>, <EulerB> and <EulerC> are entered in Degrees. Valid values for <Sequence> are 121, 123, 131, 132, 212, 213, 231, 232, 312, 313, 321, 323 |
|
| YPR | <Yaw> <Pitch> <Roll>
<Sequence>
<Yaw>, <Pitch> and <Roll> are entered in Degrees. Valid values for <Sequence> are RPY, RYP, PYR, PRY, YRP, YPR |
|
| "Aligned and Constrained" | Spherical | <RightAsc> <Declin>
<RightAsc> and <Declin> are entered in Degrees. |
| Cartesian | <X> <Y> <Z> | |
| Euler | <EulerB> <EulerC> {12 | 31
| 21 | 32}
<EulerB> and <EulerC> are entered in Degrees. |
|
| PR | <Pitch> <Roll>
<Pitch> and <Roll> are entered in Degrees. |
For details on the format of a reference component (e.g. "<Point>", "<SourceAxes>", "<Vector>", etc) see Component Specification.
When specifying a reference component or template in the Create or Modify commands the {ComponentType} is implied based on the {AxesType} being created or modified and the {ComponentType} need not be entered. In the first example below, "Satellite/ScenTestSat J2000 Axes" is entered as "Satellite/ScenTestSat J2000", since the command is expecting an axes.
To create and modify a Fixed in Axes axes:
VectorTool * Satellite/ScenTestSat Create Axes SatAxes6 "Fixed in Axes"
VectorTool * Satellite/ScenTestSat Modify Axes SatAxes6 "Fixed in Axes" Quat 1 0 0 0 "Satellite/ScenTestSat J2000"
To create and modify a Libration axes:
VectorTool * CentralBody/Earth Create Axes EarthAxes10 "Libration"
VectorTool * CentralBody/Earth Modify Axes EarthAxes10 "Libration" Earth L3 Mars Mercury Venus
To create an Angular Offset axes:
VectorTool * Satellite/ScenTestSat Create Axes SatAxes2 "Angular Offset" SpinVector "Satellite/ScenTestSat Position" RotationAngle "Satellite/ScenTestSat VertFlightPath"
To create, modify and then delete a Spinning axes template:
VectorTool * Satellite Create AxesTemplate SatAxesT2 "Spinning"
VectorTool * Satellite Modify AxesTemplate SatAxesT2 "Spinning" Epoch "1 Oct 1999 04:00:00.00" Rate 0.25 Offset 12.5
VectorTool * Satellite Delete AxesTemplate SatAxesT2
If activated, Connect returns an acknowledgement message.
This command belongs to the following group(s):
11
STK Programming Interface 11.0.1