poIMeasure GetValueList

Gets a list of values for all items in the measure.

Syntax

poIMeasure_handle GetValueList name

Application

HyperView Tcl Query

Description

This command retrieves a list of values for all items in the measure.

Inputs

name
The measure component name. Options include: mag, x_comp, y_comp, z_comp, scalar, and subcase.

Context

Elemental/Nodal Contour Example

Table 1. Regular Subcase
  m GetValueList or m GetValueList Scalar
Value checked or unchecked {contour_value}

In case of top/bottom {contour_value@Top_layer_name contour_value@Bottom_layer_name}

Table 2. Regular Subcase with Max/Min/Extreme Layers
  m GetValueList or m GetValueList Scalar
Value checked or unchecked {Contour_value corresponding_Layer_name}
Table 3. Envelope Subcase
  m GetValueList or m GetValueList Scalar
Value and subcase both checked {Contour_value}

{Subcase_internal_ID}

Value checked and subcase unchecked {Contour_value}
Value unchecked and subcase checked {Subcase_internal_ID}
Value and subcase both unchecked {Contour_value}

{Subcase_internal_ID}

Table 4. Top/bottom Layer Plot with Envelope Subcase
  m GetValueList or m GetValueList Scalar
Value and subcase both checked {contour_value@Top_layer_name Subcase_Internal_ID contour_value@Bottom_layer_name Subcase_Internal_ID}
Value checked and subcase unchecked {contour_value@Top_layer_name contour_value@Bottom_layer_name}
Value unchecked and subcase checked {Subcase_Internal_ID Subcase_Internal_ID}
Value and subcase both unchecked {contour_value@Top_layer_name Subcase_Internal_ID contour_value@Bottom_layer_name Subcase_Internal_ID}

When a Derived Loadcase is made current, two additional options are made available in the Contour panel that correspond to the Envelope Trace Plot: Subcase and Simulation.

If either Subcase or Simulation is selected from drop-down menu, when m GetValueList is invoked from the command line, it reiterates what is displayed on the screen. The values with Layer names in the case of Top/Bottom.

When m GetValueList subcase is invoked in the above two cases, the output is {}.

Incremental Angle/Relative Angle/Angle Between Example

The Measure panel has four check boxes: True Angle, X-projection, Y-projection, and Z-projection. These correspond to Mag, x_comp, y_comp, and z_comp options of m GetValueList. For this irrespective of layers being contoured, the output displayed is the same.
m GetValueList

(When all are either checked or unchecked)

{X-projection Y-projection Z-projection True_Angle}
m GetValueList

(When more than 0 options are checked)

All the corresponding entries on m GetValueList.
m GetvalueList Mag {True Angle}, irrespective of whether the True Angle check box is checked or unchecked.
m GetvalueList x_comp {X-projection}, always displays x_comp, irrespective of whether the X-projection check box is checked or unchecked.
m GetvalueList y_comp {Y-projection}, irrespective of whether the Y-projection check box is checked or unchecked.
m GetvalueList z_comp {Z-projection}, irrespective of whether the Z-projection check box is checked or unchecked.

Distance Between/Relative Displacement/Incremental Distance Example

The Measure panel has four check boxes: Magnitude, X, Y, and Z. For this irrespective of layers being contoured, the output displayed is the same. These correspond to Mag, x_comp, y_comp, and z_comp options of m GetValueList. For this irrespective of layers being contoured, the output displayed is the same.
m GetValueList

(When all are either checked or unchecked)

{X Y Z Magnitude}
m GetValueList

(When more than 0 options are checked)

All the corresponding entries on m GetValueList.
m GetvalueList Mag {Magnitude}, irrespective of whether the Magnitude check box is checked or unchecked.
m GetvalueList x_comp {X}, irrespective of whether the X-projection check box is checked or unchecked.
m GetvalueList y_comp {Y}, irrespective of whether the Y-projection check box is checked or unchecked.
m GetvalueList z_comp {Z}, irrespective of whether the Z-projection check box is checked or unchecked.

Position Example

The Measure panel has three check boxes: X, Y, and Z. These correspond to x_comp, y_comp, and z-comp options of m GetValueList. For this irrespective of layers being contoured, the output displayed is the same.
m GetValueList

(When all are either checked or unchecked)

{X Y Z}
m GetValueList

(When more than 0 options are checked)

All the corresponding entries on m GetValueList.
m GetvalueList Mag {Magnitude}, irrespective of whether the Magnitude check box is checked or unchecked.
m GetvalueList x_comp Always displays x_comp, irrespective of whether the X-projection check box is checked or unchecked.
m GetvalueList y_comp Always displays y_comp, irrespective of whether the Y-projection check box is checked or unchecked.
m GetvalueList z_comp Always displays z_comp, irrespective of whether the Z-projection check box is checked or unchecked.

Error

Returns 0 if successful, otherwise an error code.