inspect_getprop
inspect_getprop
{-prop_name s_propName | -prop_no i_index | -name_of_prop_no i_index}
[ -set d_setObj | -object d_ctuObj ]
[ -item i_index ]
[ -list_values | -count | -test_only ]
Description
Returns the value of an object property. Alternatively, the name for a property can be returned. For compound properties, a list of values or the count can be returned instead of the summary value. The object may be given directly or as an item in a set. If no object or set is given, one of the following is used, in this order:
-
The selected set, if not empty, and
-item must be given if more than one item is in the set -
The entire design
The GUI equivalent for this command is Edit—Properties.
Arguments
|
-count
|
Specifies that the number of elements for the property be returned instead of the property value. Applies only to compound properties.
|
|
-item i_index
|
Specifies the index of the object to inspect in the set. If there is only one object in the set, this argument is not needed. For a set of two objects, the first object is item 1, and the second is item 2. When the set includes more than one item, this value is required.
|
|
-list_values
|
Specifies that the list of values be returned instead of the summary value. Applies only to compound or link properties, such as elements.
|
|
-object d_ctuObj
|
Specifies the object to get the property for.
|
|
-name_of_prop_no i_index
|
|
|
Specifies that the name of the property given by the index be returned instead of the property value.
|
|
-prop_name s_propName
|
Specifies the name of the property to return the value for. This argument will accept a dot-separated path to specify a chain of inspector links.
|
|
-prop_no i_index
|
Specifies the index of the property to return the value for.
|
|
-set d_setObj
|
Specifies the set to inspect.
|
|
-test_only
|
Specifies that the return value for this command indicate whether the given property exists for the object (1: yes, 0:no).
|
Value Returned
|
d_ctuObj
|
Is the value of the property.
|
|
s_propValue
|
Is the value of the property.
|
|
s_propName
|
(-name_of_prop_no) Is the name of the property.
|
|
i_count
|
(-count) Is the number of items for the property.
|
|
s_propElement…
|
(-list_values) Is the list of property elements.
|
|
0 | 1
|
(-test_only) Indicates whether the property exists for the object.
|
Examples
The following example gets the type property value for the first item in the selected set.
inspect_getprop -prop_name type -item 1 -set [get_selection_set]
The following example gets the name property value for the object given by the net variable.
inspect_getprop -prop_name name -object $net
Related Topics
Edit Commands
inspect
inspect_prop
inspect_setprop
Return to top
