SpatialTool_R
Return information about Spatial components.
Syntax
SpatialTool_R <ScenarioPath> {Option} [<Parameters>]
Related commands
Description
The SpatialTool_R command can be used to return information about Spatial components.
{Option} | <Parameters> | Description |
---|---|---|
Exists | [Template] "<ComponentSpec>" | Returns a 1 if the specified "<ComponentSpec>" exists, otherwise 0 will be returned. Use the Template keyword if the component is a template. |
Details | [Template] "<ComponentSpec>" [IncludeDescriptions] | Returns information about the component in a single string with newline characters. Use the Template keyword if the component is a template.
With the IncludeDescriptions keyword the component type description and user description, if available, will also be returned. Use the SpatialTool_RM command to return information in a list of strings. |
Status | "<ComponentSpec>" | Returns one of these strings
The Status option is not valid for a template. |
For information on "<ComponentSpec>" formats see Component Specification.
Examples
Determine if the specified Spatial Condition exists:
SpatialTool_R * Exists "Satellite/Satellite1 SatCombined Spatial Condition"
Return message
Returns 1 if the Spatial Condition exists, otherwise returns 0Examples
Determine if the specified template Spatial Condition exists:
SpatialTool_R * Exists Template "Satellite CalcBoundsT Spatial Condition"
Return message
Returns 1 if the Spatial Condition Template exists, otherwise returns 0Examples
Return information about a default Spherical Volume Grid:
SpatialTool_R * Details "Satellite/ScenTestSat SatGrid1 Volume Grid"
Return message
Volume Grid Name: SatGrid1 Volume Grid Parent: ScenTestSat Volume Grid Type: Spherical Reference System: ScenTestSat Body Azimuth Type: Fixed Number of Steps Minimum: 0.000000 deg Maximum: 360.000000 deg Number of Steps: 36 Elevation Type: Fixed Number of Steps Minimum: -90.000000 deg Maximum: 90.000000 deg Number of Steps: 18 Range Type: Fixed Number of Steps Minimum: 1.000000 km Maximum: 50.000000 km Number of Steps: 20 Number of grid points: 14364
Group membership
This command belongs to the following group(s):
Version
11