MeshControl class is used to specify mesh settings.
The class can be called from Study class.
. More...

Public Member Functions
Condition *	CreateCondition (String &typeName, String &name)
	Creates a mesh condition. More...

Condition *	CreateLayerMesh (Selection *selection, double thickness, int division, double lamination)
	Use CreateCondition instead. More...

Condition *	CreateLayerMeshWithUnit (Selection *selection, double thickness, int division, double lamination, String &unitName)
	Use CreateCondition instead. More...

Condition *	CreateSizeCondition (String &typeName, Selection *selection, double value)
	Use CreateCondition instead. More...

Condition *	CreateSizeConditionWithUnit (String &typeName, Selection *selection, double value, String &unitName)
	Use CreateCondition instead. More...

Condition *	CreateSkinDepthSize (String &typeName, Selection *selection, double skinDepth, int division)
	Use CreateCondition instead. More...

Condition *	CreateSkinDepthSizeWithUnit (String &typeName, Selection *selection, double skinDepth, int division, String &unitName)
	Use CreateCondition instead. More...

void	DeleteCondition (Variant &val)
	Deletes a condition specifying the element size of mesh. More...

void	DeleteConditionByType (String &typeName, Variant &val)
	Use DeleteCondition instead. More...

Condition *	GetCondition (Variant &val)
	Returns the Condition object of the specified type. More...

Condition *	GetConditionByType (String &typeName, Variant &val)
	Use GetCondition instead. More...

Variant	GetConditionTypeNames ()
	Returns a list of type names for mesh condition. More...

int	GetCoordinateSystemIndex (String &propName)
	Returns the index of the coordinate system in properties. More...

String	GetCoordinateSystemName (String &propName)
	Returns the name of the coordinate system of properties. More...

String	GetFlagAsString (String &name)
	Returns the flag name set in the specified property as a string. More...

Variant	GetKeyNames (String &name)
	Returns a list of flags that can be set in the specified property. More...

Point *	GetPoint (String &propName)
	Returns the value of the property whose Type is "Vector" as a Point object. More...

String	GetPropertyHelp (String &propName)
	Returns the help of properties as a string. More...

Variant	GetPropertyNames ()
	Returns the name list of all properties that can be specified for conditions. More...

String	GetPropertyTable ()
	Returns the property name and description using a string. More...

String	GetPropertyType (String &propName)
	Returns the type of the property with the specified name. More...

DataSet *	GetTable (String &propName)
	Returns DataSet. More...

double	GetValue (String &propName)
	Returns the property values as real numbers. More...

double	GetValueWithUnit (String &propName, String &unitName)
	Returns the property values as real numbers in the specified unit. More...

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

int	NumConditions ()
	Returns the number of mesh conditions as an integer. More...

int	NumConditionsByType (String &typeName)
	Use NumConditions instead. More...

void	SetCoordinateSystem (String &propName, Variant &val)
	Specifies the coordinate system in properties. More...

void	SetFlagByName (String &propName, String &scriptKeyName)
	Specifies the name to set the value of the flag property. More...

void	SetPoint (String &propName, Point *value)
	Specifies "Vector" type properties. More...

void	SetTableProperty (String &propName, DataSet *set)
	Specifies a table for the specified properties. More...

void	SetValue (String &propName, Variant &value)
	Specifies the name to set mesh properties. More...

void	SetValueWithUnit (String &propName, double value, String &unitName)
	Specifies the name to set mesh properties in units. More...

void	SetXYZPoint (String &propName, Variant &x, Variant &y, Variant &z)
	Specifies point type properties with x, y, and z values. More...

Detailed Description

MeshControl class is used to specify mesh settings.
The class can be called from Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetMeshControl()

For more information about the properties specified by the arguments "propName" for the mesh property, see "scriptMeshCondition"

Member Function Documentation

Condition * MeshControl::CreateCondition	(	String &	typeName,
		String &	name
	)

Creates a mesh condition.

Parameters

typeName	Condition type
name	Condition Title

Returns: Condition object

For more information about the types of mesh conditions, see Properties and Flags for the Mesh Settings .

Condition * MeshControl::CreateLayerMesh	(	Selection *	selection,
		double	thickness,
		int	division,
		double	lamination
	)

Use CreateCondition instead.

Deprecated:

Adds the layer mesh.

Parameters

selection	Selection object
thickness	Thickness
division	Number of layers
lamination	Lamination factor

Returns: Condition object

Condition * MeshControl::CreateLayerMeshWithUnit	(	Selection *	selection,
		double	thickness,
		int	division,
		double	lamination,
		String &	unitName
	)

Use CreateCondition instead.

Deprecated:

Adds layer mesh with unit specification.

Parameters

selection	Selection object
thickness	Thickness
division	Number of layers
lamination	Lamination factor
unitName	Unit

Returns: Condition object

Condition * MeshControl::CreateSizeCondition	(	String &	typeName,
		Selection *	selection,
		double	value
	)

Use CreateCondition instead.

Deprecated:

Creates a mesh condition of the specified type to set the element size of the Selection range to value.

Parameters

typeName	Type name: Face Part Edge Vertex
selection	Selection object
value	Value of element size

Returns: Condition object

Condition * MeshControl::CreateSizeConditionWithUnit	(	String &	typeName,
		Selection *	selection,
		double	value,
		String &	unitName
	)

Use CreateCondition instead.

Deprecated:

Creates a mesh condition of the specified type to set the element size of the Selection range to value with unit specification.

Parameters

typeName	Type name: Face Part Edge Vertex
selection	Selection object
value	Value of element size
unitName	Unit

Returns: Condition object

Condition * MeshControl::CreateSkinDepthSize	(	String &	typeName,
		Selection *	selection,
		double	skinDepth,
		int	division
	)

Use CreateCondition instead.

Deprecated:

Creates a mesh condition of a specified type to set the element size of the Selection range to value.

Parameters

typeName	Type name
selection	Selection object
value	Value of element size
skinDepth	Skin depth
division	Number of divisions

Returns: Condition object

Condition * MeshControl::CreateSkinDepthSizeWithUnit	(	String &	typeName,
		Selection *	selection,
		double	skinDepth,
		int	division,
		String &	unitName
	)

Use CreateCondition instead.

Deprecated:

Creates a mesh condition of a specified type to set the element size of the Selection range to value with unit specification.

Parameters

typeName	Type name
selection	Selection object
value	Value of element size
skinDepth	Skin depth
division	Number of divisions
unitName	Unit

Returns: Condition object

void MeshControl::DeleteCondition ( Variant & val )

Deletes a condition specifying the element size of mesh.

Parameters

val	Name or index of the condition

For more information about the types of mesh conditions, see Properties and Flags for the Mesh Settings .

void MeshControl::DeleteConditionByType	(	String &	typeName,
		Variant &	val
	)

Use DeleteCondition instead.

Deprecated:

Deletes a condition specifying the element size of mesh.

Parameters

typeName	Type name
val	Name or index of the condition

Condition * MeshControl::GetCondition ( Variant & val )

Returns the Condition object of the specified type.

Parameters

val	Name or index of the condition

Returns: Condition object

Condition * MeshControl::GetConditionByType	(	String &	typeName,
		Variant &	val
	)

Use GetCondition instead.

Deprecated:

Returns the mesh condition for the specified type.

Parameters

typeName	Condition type name
val	Name or index of the condition

Returns: Condition object

Variant MeshControl::GetConditionTypeNames ( )

Returns a list of type names for mesh condition.

Returns: List of the type names for mesh condition

For more information about the types of mesh conditions, see Properties and Flags for the Mesh Settings .

int MeshControl::GetCoordinateSystemIndex ( String & propName )

Returns the index of the coordinate system in properties.

Parameters

propName Property name

Returns: Index of the coordinate system

String MeshControl::GetCoordinateSystemName ( String & propName )

Returns the name of the coordinate system of properties.

Parameters

propName Property name

Returns: Coordinate system name

String MeshControl::GetFlagAsString ( String & name )

Returns the flag name set in the specified property as a string.

Parameters

name	Property name

Returns: Flag name

Variant MeshControl::GetKeyNames ( String & name )

Returns a list of flags that can be set in the specified property.

Parameters

name	Property name

Returns: Flag list

Point * MeshControl::GetPoint ( String & propName )

Returns the value of the property whose Type is "Vector" as a Point object.

Parameters

propName Property name

Returns: Point object

String MeshControl::GetPropertyHelp ( String & propName )

Returns the help of properties as a string.

Parameters

propName Property name

Returns: Property help

Variant MeshControl::GetPropertyNames ( )

Returns the name list of all properties that can be specified for conditions.

Returns: All properties that can be specified for conditions

String MeshControl::GetPropertyTable ( )

Returns the property name and description using a string.

Returns: Property name and description

String MeshControl::GetPropertyType ( String & propName )

Returns the type of the property with the specified name.

Parameters

propName Property name

Returns: Property type

DataSet * MeshControl::GetTable ( String & propName )

Returns DataSet.

Parameters

propName Property name

Returns: DataSet object

double MeshControl::GetValue ( String & propName )

Returns the property values as real numbers.

Parameters

name	Property name

Returns: Property value

double MeshControl::GetValueWithUnit	(	String &	propName,
		String &	unitName
	)

Returns the property values as real numbers in the specified unit.

Parameters

name	Property name
unitName	Unit

Returns: Property value

bool MeshControl::IsValid ( )

virtual

Returns True if an object is valid.

Returns: Whether or not the MeshControl objects in the list are valid

int MeshControl::NumConditions ( )

Returns the number of mesh conditions as an integer.

Returns: Number of the mesh conditions

int MeshControl::NumConditionsByType ( String & typeName )

Use NumConditions instead.

Deprecated:

Returns the number of mesh conditions for the specified type as an integer.

Parameters

typeName Type of mesh condition

Returns: Number of mesh conditions for the specified type

void MeshControl::SetCoordinateSystem	(	String &	propName,
		Variant &	val
	)

Specifies the coordinate system in properties.

Parameters

propName	Property name
val	Name or index of the coordinate system

void MeshControl::SetFlagByName	(	String &	propName,
		String &	scriptKeyName
	)

Specifies the name to set the value of the flag property.

Parameters

propName	Property name
scriptKeyName	Flag name

void MeshControl::SetPoint	(	String &	propName,
		Point *	value
	)

Specifies "Vector" type properties.

Currently used units are used without accounting for the unit of values.

Parameters

propName	Property name
value	Point object

void MeshControl::SetTableProperty	(	String &	propName,
		DataSet *	set
	)

Specifies a table for the specified properties.

Parameters

propName	Property name
set	DataSet (table)

void MeshControl::SetValue	(	String &	propName,
		Variant &	value
	)

Specifies the name to set mesh properties.

Parameters

propName	Property name
value	Property value

void MeshControl::SetValueWithUnit	(	String &	propName,
		double	value,
		String &	unitName
	)

Specifies the name to set mesh properties in units.

Parameters

propName	Property name
value	Property value
unitName	Unit

void MeshControl::SetXYZPoint	(	String &	propName,
		Variant &	x,
		Variant &	y,
		Variant &	z
	)

Specifies point type properties with x, y, and z values.

Parameters

propName	Property name
x	X-coordinate
y	Y-coordinate
z	Z-coordinate

Public Member Functions

Detailed Description

Member Function Documentation