Description | Example | Return Message | Group

RadarClutter_RM

Get information about an object's clutter properties.

Syntax

RadarClutter_RM <ObjectPath> GetValue [<AttributePath>]

Related Commands

Description

The RadarClutter_RM command allows you to get the value(s) of a specific object's clutter properties as pointed to by a specific attribute.

If <AttributePath> is not included then the command will return the list of attributes, and the values of those attributes, for the radar clutter.

There are three properties common to all attributes that can be used to retrieve information about them - Properties, Choices, and Size. These properties should be placed at the end of the attribute path, separated from the attribute by a colon (e.g., :Choices). The following table describes these properties.

Property Description
Properties Use Properties to retrieve the currently defined values of all of the properties of the attribute. This includes items such as minimum and maximum values of the attribute, the dimension and unit of the attribute, etc.
Choices The Choices property returns a list of all possible choices for non-Boolean attributes with specific arrays of values.
Size The Size property returns the number of rows in the attribute's list, for attributes that can have rows of values.

Example

Return all the radar clutter attributes for the facility:

RadarClutter_RM */Facility/Facility1 GetValue

ReturnMessage

UserComment = STK Radar Clutter Extension
Inherit = false
ClutterMap = Constant Coefficient
ClutterMap.ClutterCoefficient = 1.00000000 units

Example

Return properties for the ClutterMap.ClutterCoefficient attribute:

RadarClutter_RM */Facility/Facility1 GetValue ClutterMap.ClutterCoefficient:Properties

ReturnMessage

ClutterMap.ClutterCoefficient:Properties.Description = ClutterCoefficient (Read-only)
ClutterMap.ClutterCoefficient:Properties.ReadOnly = false
ClutterMap.ClutterCoefficient:Properties.class = QUANTITY
ClutterMap.ClutterCoefficient:Properties.Fixed = true
ClutterMap.ClutterCoefficient:Properties.name = ClutterCoefficient
ClutterMap.ClutterCoefficient:Properties.Min = 1e-020 units (Read-only)
ClutterMap.ClutterCoefficient:Properties.Max = 1e+020 units (Read-only)
ClutterMap.ClutterCoefficient:Properties.Dimension = RatioUnit
ClutterMap.ClutterCoefficient:Properties.Unit = units

Group Membership

This command belongs to the following group(s):

Facilities, Places & Targets

Scenarios

Vehicles

Version

10.1

STK Programming Interface 11.0.1