Description | Example | Return Message | Group

Units_Get

List the current units of measure.

Syntax

Units_Get <ScenarioPath> {Option}

Related Commands

Description

Get the current units of measure being used for entering data via the user interface, displaying data in reports or entering data via Connect.

{Option} Description
GUI Return the units of measure used for entering data via the graphical user interface.
Report Return the units used when generating and displaying reports from the graphical user interface.
Connect Return the units specific to Connect that are used when entering Connect commands. The only valid dimensions for Connect units are: Distance, Time, Date, Latitude, and Longitude.
ConnectReport Return units used when generating and displaying reports during the current Connect session. These units will only be used if the ConnectReportUnitsFlag has been set to On.
Internal Returns the internal unit values for all dimensions. These are common throughout STK.
ConnectReportUnitsFlag Returns the current value of the ConnectReportUnitsFlag.
UnitNames <Dimension> Returns the list of valid unit names and abbreviations for the specified dimension. This will return: UnitName, UnitAbbreviation

Example

To get the unit values currently being used by the graphical user interface:

Units_Get * GUI

ReturnMessage

Returns the dimension name and the unit currently being used.
Distance Kilometers;
Time Seconds;
Date GregorianUTC;
Angle Degrees;
Mass Kilograms;
Power dBW;
Frequency Gigahertz;
SmallDistance Meters;
Latitude Degrees;
Longitude Degrees;
Duration Hr:Min:Sec;
Temperature Kelvin;
SmallTime Seconds;
Ratio Decibel;
Rcs Decibel;
...
SpectralBandwidth Hertz;
Bits MegaBits;
MagneticField nanoTesla;

Example

To get the valid unit names and abbreviations for the Mass dimension:

Units_Get * UnitNames Mass

ReturnMessage

Kilograms, kg
Pounds, lb
Slug, slug
Milligrams, mg
Grams, g

Example

To get the unit values being used by Connect:

Units_Get * Connect

ReturnMessage

Distance Meters;
Time Seconds;
Date GregorianUTC;
Latitude Degrees;
LongitudeUnit Degrees;

ReturnMessage

If activated, Connect returns an acknowledgement message.

Group Membership

This command belongs to the following group(s):

Scenarios

Version

10.1

STK Programming Interface 11.0.1