Units_Get
List the current units of measure.
Syntax
Units_Get <ScenarioPath> {Option} [Abbreviation]
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.
The Abbreviation parameter will return the unit abbreviations rather than unit names. This parameter is valid for the following Options: GUI, Report, Connect, ConnectReport, and Internal.
{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 |
Examples
To get the unit values currently being used by the graphical user interface:
Units_Get * GUI
Return message
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;
Examples
To get the valid unit names and abbreviations for the Mass dimension:
Units_Get * UnitNames Mass
Return message
Kilograms, kg Pounds, lb Slug, slug Milligrams, mg Grams, g
Examples
To get the unit names being used by Connect:
Units_Get * Connect
Return message
Distance Meters; Time Seconds; Date GregorianUTC; Latitude Degrees; Longitude Degrees;
To get the unit abbreviations being used by Connect:
Units_Get * Connect Abbreviation
Return message
Distance m; Time sec; Date UTCG; Latitude deg; Longitude deg;
Group membership
This command belongs to the following group(s):
Version
11.2