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.
Selection *	GetCenter ()
	Returns the Selection object of center point in a measurement variable. More...
String	GetName ()
	Returns MeasurementVariable name. More...
Point *	GetPoint ()
	Returns the designated point as a Point object. More...
Selection *	GetSelection ()
	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	SetCenter (Selection *selection)
	Adds the selected vertex to the MeasurementVariable center point. More...
void	SetName (String &name)
	Specifies a MeasurementVariable name. More...
void	SetPoint (double x, double y, double z)
	Specifies the properties of the Point type using x, y, and z. 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

selection

Selected parts, faces, or edges

Selection * MeasurementVariable::GetCenter

(

)

Returns the Selection object of center point in a measurement variable.

Returns

Selection object

String MeasurementVariable::GetName

(

)

Returns MeasurementVariable name.

Returns

Measurement variable name

Point * MeasurementVariable::GetPoint

(

)

Returns the designated point as a Point object.

Returns

Point object

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

Volume = Part Volume
Face = Face Area
Edge = Edge Length
TwoEntitiesShortest = Two Entities (Shortest Distance)
TwoEntitiesPerpendicular = Two Entities (Perpendicular Distance)
EntityAndPointShortest = Entity and Point (Shortest Distance)
EntityAndPointPerpendicular = Entity and Point (Perpendicular Distance)
TwoEntitiesAngle = Two Entities Angle
ThreePointAngle = Three Point Angle
TwoPointsAndCenterAngle = Two Points and Centre Angle
ArcRadius = Arc Radius

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::SetCenter

(

Selection *

selection

)

Adds the selected vertex to the MeasurementVariable center point.

Parameters

selection

Selected vertex

void MeasurementVariable::SetName

(

String &

name

)

Specifies a MeasurementVariable name.

Parameters

name	Measurement variable name

void MeasurementVariable::SetPoint	(	double	x,
		double	y,
		double	z
	)

Specifies the properties of the Point type using x, y, and z.

Parameters

x	X-coordinate
y	Y-coordinate
z	Z-coordinate

void MeasurementVariable::SetType

(

String &

type

)

Specifies a MeasurementVariable type.

Parameters

type

Measurement variable type Volume = Part Volume Face = Face Area Edge = Edge Length TwoEntitiesShortest = Two Entities (Shortest Distance) TwoEntitiesPerpendicular = Two Entities (Perpendicular Distance) EntityAndPointShortest = Entity and Point (Shortest Distance) EntityAndPointPerpendicular = Entity and Point (Perpendicular Distance) TwoEntitiesAngle = Two Entities Angle ThreePointAngle = Three Point Angle TwoPointsAndCenterAngle = Two Points and Centre Angle ArcRadius = Arc Radius