Set class is used for set settings.
The class can be called from SetList or CalculationDefinition class
. More...

Public Member Functions
void	AddSelected (Selection *selection)
	Adds the selected parts, faces, edges, or vertices to the set. More...

void	ClearParts ()
	Removes all parts, faces, edges, or vertices from the set.

Variant	GetIDs ()
	Returns information of parts, faces, edges, or vertices included in a set. More...

String	GetMatcherType ()
	Returns the specification method for sets. More...

String	GetName ()
	Returns set name. More...

Variant	GetParameter (String &name)
	Returns the specified parameter value. More...

StringList	GetParameterList ()
	Returns the list of parameters. More...

Point *	GetPoint (String &propName)
	Returns the property value for the Vector type as a Point object. More...

Selection *	GetSelection ()
	Returns the Selection object of part, face, edge, or vertex included in a set. More...

String	GetType ()
	Returns set type. More...

bool	IsValid ()
	Returns True if an object is valid. More...

int	NumParts ()
	Returns the number of parts, faces, edges, or vertices. More...

void	Rebuild ()
	Rebuilds set settings.

void	SetCoordinateSystem (String &propName, Variant &value)
	Specifies parameter of coordinate system as name or index when the set specification method is "OnHalfPlane" or "OnRectangle". More...

void	SetMatcherType (String &type)
	Specifies the specification method of sets. More...

void	SetName (String &name)
	Specifies a set name. More...

void	SetParameter (String &name, Variant &value)
	Specifies a parameter value. More...

void	SetUpdateByRelation (bool update)
	Specifies whether to consider Parent-Child relation (Condition Parts to setting target). More...

void	SetXYZPoint (String &name, double x, double y, double z)
	Specifies parameter of Point type as "xyz". More...

bool	UpdateByRelation ()
	Returns the set parent-child relationship update flag. More...

Detailed Description

Set class is used for set settings.
The class can be called from SetList or CalculationDefinition class
.

Example of calling the class object:

app.GetModel(0).GetSetList().GetSet(0)

Member Function Documentation

void Set::AddSelected ( Selection * selection )

Adds the selected parts, faces, edges, or vertices to the set.

Parameters

selection Selected parts, faces, edges, or vertices

Variant Set::GetIDs ( )

Returns information of parts, faces, edges, or vertices included in a set.

Returns: IDs of the parts, faces, edges, or vertices included in a set

String Set::GetMatcherType ( )

Returns the specification method for sets.

Returns: Type name

For more information of type name, see SetMatcherType.

String Set::GetName ( )

Returns set name.

Returns: Set name

Variant Set::GetParameter ( String & name )

Returns the specified parameter value.

Parameters

name	Parameter name

Returns: the Parameter value

StringList Set::GetParameterList ( )

Returns the list of parameters.

Returns: Parameter list

Point * Set::GetPoint ( String & name )

Returns the property value for the Vector type as a Point object.

Parameters

name	Parameter name

Returns: Point object

Selection * Set::GetSelection ( )

Returns the Selection object of part, face, edge, or vertex included in a set.

Returns: Selection object

String Set::GetType ( )

Returns set type.

Returns: Set type (part, face, edge, or vertex)

bool Set::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the Set object is valid

int Set::NumParts ( )

Returns the number of parts, faces, edges, or vertices.

Returns: The number of the parts, faces, edges, or vertices

void Set::SetCoordinateSystem	(	String &	propName,
		Variant &	value
	)

Specifies parameter of coordinate system as name or index when the set specification method is "OnHalfPlane" or "OnRectangle".

Parameters

propName	Parameter name "coordinate" : Coordinate system
value	Name or index of the coordinate system

void Set::SetMatcherType ( String & type )

Specifies the specification method of sets.

Parameters

type

Specification method
"Selection" ： Click to select
"OnPlane" ： Select on a plane (used when set type is face, edge, or vertex).
"OnHalfPlane" ： Select on a half plane (used when set type is face, edge, or vertex).
"OnRectangle" ： Select on a rectangle (used when set type is face, edge, or vertex).
"MatchNames" ： Selects by name (used when set type is parts).

void Set::SetName ( String & name )

Specifies a set name.

Parameters

name	Set names of part, face, edge, and vertex

void Set::SetParameter	(	String &	propName,
		Variant &	value
	)

Specifies a parameter value.

Parameters

propName
value	Parameter name "style" : Specification method of character string (used when the set specification method is "MatchNames"） "text" : Text (used when the specification method is "MatchNames") "tolerance" : Tolerance (used when the specification method is "OnPlane" "OnHalfPlane" "OnRectangle") "axis_type" : Axial Direction（used when the specification method is "OnHalfPlane"）
value	Value Flag name when the parameter name is "style." "prefix" : Grouping from the beginning of a character string "postfix" : Grouping from the end of a character string "regexp" : Regular expression String when the parameter name is "text." Real number when the parameter name is "tolerance." Integer number when the parameter name is "axis_type." 0 : First Axial Direction 1 : Second Axial Direction

void Set::SetUpdateByRelation ( bool update )

Specifies whether to consider Parent-Child relation (Condition Parts to setting target).

Parameters

The	parent-child relationship update flag True=1 : Considered False=0 : Does not considered

void Set::SetXYZPoint	(	String &	propName,
		double	x,
		double	y,
		double	z
	)

Specifies parameter of Point type as "xyz".

Parameters

propName	Parameter name "direction" : Normal vector (used when the set specification method is "OnPlane"） "origin" : Point on plane (used when the set specification method is "OnPlane"） "lowest_point" : Lowest point (used when the set specification method is "OnRectangle"） "highest_point" : Highest point (used when the set specification method is "OnRectangle"）
x	X-component of vector / Value of the X-coordinate
y	Y-component of vector / Value of the Y-coordinate
z	Z-component of vector / Value of the Z-coordinate

bool Set::UpdateByRelation ( )

Returns the set parent-child relationship update flag.

Returns: The set parent-child relationship update flag

Public Member Functions

Detailed Description

Member Function Documentation