Public Member Functions | List of all members
MeasurementVariable Class Reference

MeasurementVariable class is used for MeasurementVariable settings.
The class can be called from MeasurementVariableList class.
. More...

Public Member Functions

void AddSelected (Selection *selection)
 Adds the selected parts, faces, or edges to the MeasurementVariable. More...
 
void ClearParts ()
 Removes all parts, faces, or edges from the measurement variable.
 
String GetName ()
 Returns MeasurementVariable name. More...
 
SelectionGetSelection ()
 Returns the Selection object of parts, faces, or edges included in a measurement variable. More...
 
String GetType ()
 Returns MeasurementVariable type. More...
 
bool IsValid ()
 Returns True if an object is valid. More...
 
int NumParts ()
 Returns the number of parts, faces, or edges. More...
 
void SetName (String &name)
 Specifies a MeasurementVariable name. More...
 
void SetType (String &type)
 Specifies a MeasurementVariable type. More...
 

Detailed Description

MeasurementVariable class is used for MeasurementVariable settings.
The class can be called from MeasurementVariableList class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetMeasurementVariableList().GetMeasurementVariable(0)

Member Function Documentation

void MeasurementVariable::AddSelected ( Selection selection)

Adds the selected parts, faces, or edges to the MeasurementVariable.

Parameters
selectionSelected parts, faces, or edges
String MeasurementVariable::GetName ( )

Returns MeasurementVariable name.

Returns
Measurement variable name
Selection * MeasurementVariable::GetSelection ( )

Returns the Selection object of parts, faces, or edges included in a measurement variable.

Returns
Selection object
String MeasurementVariable::GetType ( )

Returns MeasurementVariable type.

Returns
Measurement variable type (part, face, or edge)
bool MeasurementVariable::IsValid ( )

Returns True if an object is valid.

Returns
Whether or not the MeasurementVariable object is valid
int MeasurementVariable::NumParts ( )

Returns the number of parts, faces, or edges.

Returns
Number of parts, faces, or edges
void MeasurementVariable::SetName ( String &  name)

Specifies a MeasurementVariable name.

Parameters
nameMeasurement variable name
void MeasurementVariable::SetType ( String &  type)

Specifies a MeasurementVariable type.

Parameters
typeMeasurement variable type (part, face, or edge)