Condition Class is used to handle condition parameters.
The class can be called from Study class.
. More...

Inherits ParameterList.

Public Member Functions
void	AddGroup (MeshGroup *set, int group)
	Adds a [MeshGroup object] by specifying a name or index to a condition setting group. More...

void	AddPart (Variant &val)
	Adds a part, face, or edge to a group by specifying the name or ID. More...

void	AddPartByGroup (Variant &val, int group)
	Adds a new part, face, or edge to the specified group. More...

void	AddPartByTargetType (Variant &val, String &targetTypeName)
	There are setting types (part, face, or edge) that can be selected depending on the condition. This command adds the parts, faces, or edges to the setting group by specifying the its type and the name or ID. More...

void	AddSecondaryPart (Variant &val)
	Adds a part, face, or edge to the secondary group if there are two groups for the condition. More...

void	AddSecondarySelected (Selection *selection)
	Adds a part, face, or edge that is selected secondary using a Selection object to a condition group. More...

void	AddSelected (Selection *selection)
	Adds a part, face, or edge that is selected using a Selection object to a condition group. More...

void	AddSelectedByGroup (Selection *Selection, int group)
	Adds a part, face, or edge that is selected secondary using a Selection object to a condition group. More...

void	AddSet (Set *set, int group)
	Adds a [Set] by specifying a name or index to a condition setting group. More...

void	AddSetFromModel (Variant &val, int group)
	Adds a [Model] by specifying a name or index to a condition setting group. More...

void	AddSubCondition (Variant &val, int subIndex)
	Inserts the lower conditions to the condition by specifying the name or index. More...

void	AddTarget (String &name)
	Adds an arbitrary section/edge to the target. More...

double	CalculateInertiaValue ()
	Calculates and returns a Inertia Moment / Mass. More...

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

void	ClearPartsByGroup (int group)
	Removes all parts, faces, or edges from the condition. More...

void	ClearTargets ()
	Removes all arbitrary sections and arbitrary edges from the target.

Condition *	CreateSubCondition (String &typeName, String &name)
	Returns a Condition object by specifying the type name and name. More...

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

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

virtual String	GetFlagAsString (String &name)
	Returns the settings for the specified properties as a flag property name. More...

virtual String	GetFlagPropertyHelp (String &propName, Variant &val)
	Returns the help of the flag property as a string for the specified index or name. More...

FunctionObject *	GetFunction ()
	Returns a FunctionObject object for the corresponding condition. More...

String	GetInstanceLink (String &propName)
	Returns circuit component name related to the condition. More...

Variant	GetKeyNames (String &name)
	Returns the flag name as a string list. More...

String	GetLink ()
	Returns the name of the circuit component that is link to the condition. More...

String	GetLinkWithType (String &type)
	Returns the names of the conditions and circuit components that are linked. More...

Material *	GetMaterial (String &propName)
	Returns the material assigned to the electromagnetic steel sheet and insulation of the layered mesh. More...

String	GetName ()
	Returns a condition name as a string. More...

Variant	GetParts ()
	Returns the list of part/face/edge IDs as a table. More...

Variant	GetPartsByGroup (int group)
	Returns the list of part/face/edge IDs that are included in the specified group as a table. More...

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

Point *	GetPointWithUnit (String &propName, String &unitName)
	Returns the property value for the Vector type as a Point object by specifying the unit. More...

virtual String	GetPropertyHelp (String &propName)
	Returns the help of the flag property as a string for the specified index or name. More...

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

String	GetPropertyTable ()
	Returns the list of properties including the type and help. More...

virtual String	GetPropertyType (String &propName)
	Returns a property type. More...

ReferenceTarget *	GetReferenceTarget (String &propName)
	Returns the value of reference target for the specified property. More...

String	GetScriptTypeName ()
	Returns name of condition type as a character string. More...

Variant	GetSecondaryParts ()
	Returns the list of part/face/edge IDs of the secondary group as a table if there are two groups in the condition. More...

Selection *	GetSecondarySelection ()
	Returns a part, face, or edge of the secondary group as a Selection object if there are two groups in the condition. More...

Selection *	GetSelection ()
	Returns the parts, faces, or edges in the group as a Selection object. More...

Selection *	GetSelectionByGroup (int group)
	Returns all parts, faces, or edges in the specified group as a Selection object. More...

Set *	GetSet (int index, int group)
	Returns Set object to a calculation by specifying index. More...

virtual String	GetStringValue (String &propName)
	Returns the value of the named property. More...

Condition *	GetSubCondition (Variant &val)
	Returns a Condition object of the lower condition by specifying the name or index. More...

DataSet *	GetTable (String &propName)
	Returns the value of the specified table property. More...

DataSetList *	GetTableList (String &propName)
	Returns the table list of the specified property. More...

String	GetType ()
	Returns condition name as a character string. More...

virtual double	GetValue (String &propName)
	Returns the value of property as a real number. More...

virtual double	GetValueWithUnit (String &propName, String &unitName)
	Returns the value of the named property as a real number in the specified unit. More...

bool	HasTargetOnXYPlane (double tolerance=1e-6)
	Returns true if there is the entity to be on the XY plane. More...

bool	HasTargetOnYZPlane (double tolerance=1e-6)
	Returns true if there is the entity to be on the YZ plane. More...

bool	HasTargetOnZXPlane (double tolerance=1e-6)
	Returns true if there is the entity to be on the ZX plane. More...

void	InsertSubCondition (Condition *condition, int subIndex)
	Inserts a lower condition to the condition by specifying the Condition object. More...

void	InsertSubConditionByIndex (int conditionIndex, int subIndex)

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

bool	NodeIsOnTarget (int nodeId, double tolerance=1e-6)
	Since this is an internal function, it is not officially supported. More...

int	NumSets (int group)
	Returns the number of Sets included in a calculation with specified name or index. More...

int	NumSubConditions ()
	Returns the number of lower conditions as an integer. More...

void	RemoveAllSets (int group)
	Removes all sets from a condition. More...

void	RemovePart (int id)
	Removes a specific part, face, or edge from a group. More...

void	RemovePartByGroup (int id, int group)
	Removes a specific part, face, or edge from the specified group by specifying the part/face/edge ID. More...

void	RemovePartByTargetType (int id, String &targetTypeName)
	There are setting types (part, face, or edge) that can be selected depending on the condition. This command removes the parts, faces, or edges from the setting group by specifying the its type and the name or ID. More...

void	RemoveSecondaryPart (int id)
	Removes a specific part, face, or edge from the secondary group if there are two groups in the condition. More...

void	RemoveSet (Variant &val, int group)
	Removes a set from a condition by specifying the name or index. More...

void	RemoveSubCondition (Variant &val)
	Deletes a lower condition by specifying the name or index. More...

virtual void	SetComplexValue (String &propName, double real, double imag)
	Specifies the value of the complex property. More...

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

void	SetDirectionFromReferenceTarget (String &propName, ReferenceTarget *ref, String &directionType=String())
	Specifies the specified direction property in the condition from a reference target. More...

virtual void	SetFlagByName (String &propName, String &scriptKeyName)
	Specifies the value of flag property for the specified name. More...

void	SetFunction (FunctionObject *func)
	Specifies the function value that is specified for the properties. More...

void	SetInstanceLink (String &propName, Variant &val)
	Specifies circuit components that are related to conditions. More...

void	SetLink (String &name)
	Specifies a circuit component to link to the condition. More...

void	SetLinkWithType (Variant &type, Variant &val)
	Specifies the condition and circuit component to link to the condition. More...

void	SetMaterial (String &propName, Material *material)
	Assigns a material for electromagnetic steel sheet or insulation for the layered mesh using variables. More...

void	SetMaterialByName (String &propName, String &matname)
	Assigns a material for electromagnetic steel sheet or insulation for the layered mesh using the name of the material. More...

void	SetName (String &name)
	Specifies the name of a condition. More...

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

void	SetPointWithUnit (String &propName, Point *value, String &unitName)
	Specifies the properties of the Vector type by specifying the unit. More...

void	SetTable (String &propName, String array &mat)
	Specifies the value in the specified table for the properties. More...

void	SetTableFromFile (String &propName, String &filename)
	Specifies a point sequence for a property that is specified, by importing a point sequence file (.csv, .txt, *.pa). More...

void	SetTableList (String &propName, double primaryKey, String &primaryUnitName, String array &mat)
	Specifies the name for the dataset list (multiple tables). More...

void	SetTableListName (String &propName, String &name)
	Specifies the name for the dataset list (multiple tables). More...

void	SetTableListWithDualKey (String &propName, double primaryKey, String &primaryUnitName, double secondaryKey, String &secondaryUnitName, String array &mat)
	Specifies a point sequence for the multidimensional array of the specified primary key and secondary key in the dataset list (multiple tables). More...

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

void	SetTableWithUnit (String &propName, String array &mat, StringList &unitlist)
	Specifies the value of the specified table property. More...

void	SetTextTable (String &propName, String array &mat)
	Specifies the value in the specified string table for the properties. More...

virtual void	SetValue (String &propName, Variant &value)
	Specifies the value of the real number property or flag property. More...

virtual void	SetValueWithUnit (String &propName, double value, String &unitName)
	Specifies the value of the named property. More...

void	SetXYZPoint (String &propName, Variant &x, Variant &y, Variant &z)
	Specifies the properties of the Point type using x, y, and z. More...

void	SetXYZPointWithUnit (String &propName, double x, double y, double z, String &unitName)
	Specifies the properties of the Point type using x, y, and z by specifying the unit. More...

Detailed Description

Condition Class is used to handle condition parameters.
The class can be called from Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetCondition(0)

The property name and flag described in Properties and Flags for Condition Settings are used to specify the properties for each condition.

Member Function Documentation

void Condition::AddGroup	(	MeshGroup *	set,
		int	group
	)

Adds a [MeshGroup object] by specifying a name or index to a condition setting group.

Parameters

set	Name or index of the MeshGroup object
group	Group ID

void Condition::AddPart ( Variant & val )

Adds a part, face, or edge to a group by specifying the name or ID.

Parameters

val	Name or ID of the art, face, or edge

void Condition::AddPartByGroup	(	Variant &	val,
		int	group
	)

Adds a new part, face, or edge to the specified group.

Parameters

val	Name or ID of the part, face, or edge
group	Group ID

This command is used when there are multiple list boxes in the settings.
For example, in the [Part Relation] settings, "group=1" is assigned for the [Parent Parts] box as a group ID, "group=2" for the [Copied Parts] box, and "group=3" for the [Mirror Copied Parts] box.

void Condition::AddPartByTargetType	(	Variant &	val,
		String &	targetTypeName
	)

There are setting types (part, face, or edge) that can be selected depending on the condition. This command adds the parts, faces, or edges to the setting group by specifying the its type and the name or ID.

Parameters

val	Name or ID of the part, face, or edge
targetTypeName	Type Face Part Edge

void Condition::AddSecondaryPart ( Variant & val )

Adds a part, face, or edge to the secondary group if there are two groups for the condition.

Parameters

val	Name or ID of the part, face, or edge

void Condition::AddSecondarySelected ( Selection * selection )

Adds a part, face, or edge that is selected secondary using a Selection object to a condition group.

Parameters

selection Selection object (The part, face, or edge that is selected.)

void Condition::AddSelected ( Selection * selection )

Adds a part, face, or edge that is selected using a Selection object to a condition group.

Parameters

selection Selection (The part, face, or edge that is selected.)

void Condition::AddSelectedByGroup	(	Selection *	Selection,
		int	group
	)

Adds a part, face, or edge that is selected secondary using a Selection object to a condition group.

Parameters

selection	Selection (The part, face, or edge that is selected.)
group	Group ID

For information about the group ID, see MEMO of AddPartByGroup() .

void Condition::AddSet	(	Set *	set,
		int	group
	)

Adds a [Set] by specifying a name or index to a condition setting group.

Parameters

set	Name or index of the set
group	Group ID

void Condition::AddSetFromModel	(	Variant &	val,
		int	group
	)

Adds a [Model] by specifying a name or index to a condition setting group.

Parameters

val	Name or index of the model
group	Group ID

void Condition::AddSubCondition	(	Variant &	val,
		int	subIndex
	)

Inserts the lower conditions to the condition by specifying the name or index.

Parameters

val	Name or Index of the condition to insert
subIndex	Index of the lower conditions

void Condition::AddTarget ( String & name )

Adds an arbitrary section/edge to the target.

Parameters

name	Calculation target name

double Condition::CalculateInertiaValue ( )

Calculates and returns a Inertia Moment / Mass.

Returns: Inertia Moment / Mass

void Condition::ClearPartsByGroup ( int group )

Removes all parts, faces, or edges from the condition.

Parameters

group Group ID

For information about the group ID, see MEMO of AddPartByGroup() .

Condition * Condition::CreateSubCondition	(	String &	typeName,
		String &	name
	)

Returns a Condition object by specifying the type name and name.

This command is used to create a group (lower condition) under FEM coil condition.

Parameters

typeName	Condition type name
name	Condition name

Returns: Condition object

For information about the condition type name that can be specified as typeName , see Condition Settings for Magnetic Field Analysis .

int Condition::GetCoordinateSystemIndex ( String & propName )

Returns the properties of the coordinate system by specifying the index.

Parameters

propName Property name

Returns: Index of the coordinate system

String Condition::GetCoordinateSystemName ( String & propName )

Returns the properties of the coordinate system by specifying the name.

Parameters

propName Property name

Returns: Name of the coordinate system

String ParameterList::GetFlagAsString ( String & name )

virtualinherited

Returns the settings for the specified properties as a flag property name.

Parameters

name	Property name

Returns: DataSet object (table of properties)

String ParameterList::GetFlagPropertyHelp	(	String &	propName,
		Variant &	val
	)

virtualinherited

Returns the help of the flag property as a string for the specified index or name.

Parameters

propName	Property name
val	Flag index/Flag name

Returns: Help of the flag property

FunctionObject * Condition::GetFunction ( )

Returns a FunctionObject object for the corresponding condition.

Returns: FunctionObject object

String Condition::GetInstanceLink ( String & propName )

Returns circuit component name related to the condition.

The following patterns exist.

Heat Source condition and Resistor component
Heat Generation Component condition and Heat Generation component
Temperature Distribution condition and Thermal Probe component

Parameters

propName

ResistorID : Resistor component ID
HeatGenerationComponentId : Heat Generation component ID
ThermalProbeID : Thermal Probe component ID

Returns: Name of the circuit component

Variant ParameterList::GetKeyNames ( String & name )

inherited

Returns the flag name as a string list.

Parameters

name	Property name

Returns: Flag name

String Condition::GetLink ( )

Returns the name of the circuit component that is link to the condition.

Returns: Name of the circuit component

For details of the circuit components, see Circuit , CircuitComponent , CircuitComponentInstance , CircuitWire and Properties and Flags for the Circuit Settings .
For instructions on how to link conditions to circuit components, see "Specifying the Linked FEM Coil in the Circuit" and Properties and Flags for the Circuit Settings .

String Condition::GetLinkWithType ( String & type )

Returns the names of the conditions and circuit components that are linked.

Parameters

type	Type name Resistance : Resistor component FEM coil : FEM Coil condition

Returns: Names of the conditions/circuit components

SetLinkWithType() and GetLinkWithType() can only be used for the heat source condition of magnetic field analysis.

Material * Condition::GetMaterial ( String & propName )

Returns the material assigned to the electromagnetic steel sheet and insulation of the layered mesh.

Parameters

propName

SteelSheetMaterial : Electromagnetic steel sheet material

InsulationMaterial : Insulation material

Returns: Material object

String Condition::GetName ( )

Returns a condition name as a string.

Returns: Name of the condition

Variant Condition::GetParts ( )

Returns the list of part/face/edge IDs as a table.

Returns: List of part/face/edge IDs

Variant Condition::GetPartsByGroup ( int group )

Returns the list of part/face/edge IDs that are included in the specified group as a table.

Parameters

group Group ID

Returns: List of part/face/edge IDs

For information about the group ID, see MEMO of AddPartByGroup() .

Point * Condition::GetPoint ( String & propName )

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

Parameters

propName Property name

Returns: Point object

Point * Condition::GetPointWithUnit	(	String &	propName,
		String &	unitName
	)

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

Parameters

propName Property namet

Returns: Point object

Parameters

unitName Unit

String ParameterList::GetPropertyHelp ( String & propName )

virtualinherited

Returns the help of the flag property as a string for the specified index or name.

Parameters

propName Property name

Returns: Help of the property

Variant ParameterList::GetPropertyNames ( )

inherited

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

Returns: List of all properties for the condition

String ParameterList::GetPropertyTable ( )

inherited

Returns the list of properties including the type and help.

Returns: List of the properties

String ParameterList::GetPropertyType ( String & propName )

virtualinherited

Returns a property type.

Parameters

propName Property name

Returns: Property type

ReferenceTarget * Condition::GetReferenceTarget ( String & propName )

Returns the value of reference target for the specified property.

Parameters

propName Property name

Returns: ReferenceTarget object

String Condition::GetScriptTypeName ( )

Returns name of condition type as a character string.

Returns: Type name of condition

For more information about type names for condition, see Properties and Flags for Condition Settings .

Variant Condition::GetSecondaryParts ( )

Returns the list of part/face/edge IDs of the secondary group as a table if there are two groups in the condition.

Returns: List of part/face/edge IDs

Selection * Condition::GetSecondarySelection ( )

Returns a part, face, or edge of the secondary group as a Selection object if there are two groups in the condition.

Returns: Selection object

Selection * Condition::GetSelection ( )

Returns the parts, faces, or edges in the group as a Selection object.

Returns: Selection object

Selection * Condition::GetSelectionByGroup ( int group )

Returns all parts, faces, or edges in the specified group as a Selection object.

Parameters

group Group ID

Returns: Selection object

For information about the group ID, see MEMO of AddPartByGroup() .

Set * Condition::GetSet	(	int	index,
		int	group
	)

Returns Set object to a calculation by specifying index.

Parameters

index	Index
group	Group ID

String ParameterList::GetStringValue ( String & propName )

virtualinherited

Returns the value of the named property.

Parameters

propName Property name

Returns: Property value

Reimplemented in StudyProperties.

Condition * Condition::GetSubCondition ( Variant & val )

Returns a Condition object of the lower condition by specifying the name or index.

Parameters

val	Name or index of the condition

Returns: Condition object

DataSet * ParameterList::GetTable ( String & propName )

inherited

Returns the value of the specified table property.

Parameters

propName Property name

Returns: DataSet (table)

DataSetList * ParameterList::GetTableList ( String & propName )

inherited

Returns the table list of the specified property.

Parameters

propName Property name

Returns: DataSetList (table list)

String Condition::GetType ( )

Returns condition name as a character string.

Returns: Name of the condition

The condition name specified in the command is the condition name displayed in the treeview of JMAG-Designer. For example, "Motion : Rotation", "Rotation Periodic Boundary", "Torque : Nodal Force" is returned.

double ParameterList::GetValue ( String & propName )

virtualinherited

Returns the value of property as a real number.

Parameters

propName Property name

Returns: Property value

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

virtualinherited

Returns the value of the named property as a real number in the specified unit.

Parameters

propName	Property name
unitName	Unit

Returns: Property value

bool Condition::HasTargetOnXYPlane ( double tolerance = 1e-6 )

Returns true if there is the entity to be on the XY plane.

Parameters

tolerance Tolerance

bool Condition::HasTargetOnYZPlane ( double tolerance = 1e-6 )

Returns true if there is the entity to be on the YZ plane.

Parameters

tolerance Tolerance

bool Condition::HasTargetOnZXPlane ( double tolerance = 1e-6 )

Returns true if there is the entity to be on the ZX plane.

Parameters

tolerance Tolerance

void Condition::InsertSubCondition	(	Condition *	condition,
		int	subIndex
	)

Inserts a lower condition to the condition by specifying the Condition object.

Parameters

condition	Condition object
subIndex	Index of the lower conditions

void Condition::InsertSubConditionByIndex	(	int	conditionIndex,
		int	subIndex
	)

Deprecated:

Inserts the lower conditions to the condition by specifying the indexes.

Parameters

conditionIndex	Index of the condition to insert.
subIndex	Index of the lower conditions

bool ParameterList::IsValid ( )

virtualinherited

Returns True if an object is valid.

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

Reimplemented in MaterialObject, CircuitComponent, StudyProperties, and Step.

bool Condition::NodeIsOnTarget	(	int	nodeId,
		double	tolerance = `1e-6`
	)

Since this is an internal function, it is not officially supported.

Deprecated:

int Condition::NumSets ( int group )

Returns the number of Sets included in a calculation with specified name or index.

Parameters

group Group ID

Returns: Number of sets

int Condition::NumSubConditions ( )

Returns the number of lower conditions as an integer.

Returns: Number of conditions in the study

void Condition::RemoveAllSets ( int group )

Removes all sets from a condition.

Parameters

group Group ID

void Condition::RemovePart ( int id )

Removes a specific part, face, or edge from a group.

Parameters

id	Part/face/edge ID

For details of the part/face/edge ID, see " ID ."

void Condition::RemovePartByGroup	(	int	id,
		int	group
	)

Removes a specific part, face, or edge from the specified group by specifying the part/face/edge ID.

Parameters

id	Part/face/edge ID
group	Group ID

For information about the group ID, see MEMO of AddPartByGroup() .

void Condition::RemovePartByTargetType	(	int	id,
		String &	targetTypeName
	)

There are setting types (part, face, or edge) that can be selected depending on the condition. This command removes the parts, faces, or edges from the setting group by specifying the its type and the name or ID.

Parameters

id	Part ID, face ID, or edge ID
targetTypeName	Settings type : Face Part Edge

For information about the group ID, see MEMO of AddPartByGroup() .

void Condition::RemoveSecondaryPart ( int id )

Removes a specific part, face, or edge from the secondary group if there are two groups in the condition.

Parameters

id	Part/face/edge ID

void Condition::RemoveSet	(	Variant &	val,
		int	group
	)

Removes a set from a condition by specifying the name or index.

Parameters

val	Name or index of the set
group	Group ID

void Condition::RemoveSubCondition ( Variant & val )

Deletes a lower condition by specifying the name or index.

Returns: Name or index of the condition

void ParameterList::SetComplexValue	(	String &	propName,
		double	real,
		double	imag
	)

virtualinherited

Specifies the value of the complex property.

The unit that is currently being used is used. A real number value is converted into an integer for the flag property.

Parameters

propName	Property name
real	Property value (real part)
imag	Property value (imaginary part)

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

Specifies the properties of the coordinate system.

Parameters

propName	Property name
val	Name or index of the coordinate system

void Condition::SetDirectionFromReferenceTarget	(	String &	propName,
		ReferenceTarget *	ref,
		String &	directionType = `String()`
	)

Specifies the specified direction property in the condition from a reference target.

Parameters

propName	Property name
ref	ReferenceTarget object
directionType	The method to use for edge targets (arc, perpendicular or can be empty)

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

virtualinherited

Specifies the value of flag property for the specified name.

Parameters

propName	Property name
scriptKeyName	Flag name

void Condition::SetFunction ( FunctionObject * func )

Specifies the function value that is specified for the properties.

Parameters

func	Function Object

void Condition::SetInstanceLink	(	String &	propName,
		Variant &	val
	)

Specifies circuit components that are related to conditions.

The following patterns exist:

Heat Source condition and Resistor component
Heat Generation Component condition and Heat Generation component
Temperature Distribution condition and Thermal Probe component

Parameters

propName	ResistorID : Resistor component ID HeatGenerationComponentId : Heat Generation component ID ThermalProbeID : Thermal Probe component ID
val	Component name or index

void Condition::SetLink ( String & name )

Specifies a circuit component to link to the condition.

Parameters

name	Circuit component name

void Condition::SetLinkWithType	(	Variant &	type,
		Variant &	val
	)

Specifies the condition and circuit component to link to the condition.

Parameters

type	Type name Resistance : Resistor component FEM coil : FEM Coil condition
val	Condition name, circuit component name or index

void Condition::SetMaterial	(	String &	propName,
		Material *	material
	)

Assigns a material for electromagnetic steel sheet or insulation for the layered mesh using variables.

Parameters

propName	SteelSheetMaterial : Electromagnetic steel sheet material InsulationMaterial : Insulation material
material	Material object

void Condition::SetMaterialByName	(	String &	propName,
		String &	matname
	)

Assigns a material for electromagnetic steel sheet or insulation for the layered mesh using the name of the material.

Parameters

propName	SteelSheetMaterial : Electromagnetic steel sheet material InsulationMaterial : Insulation material
matname	Material name

void Condition::SetName ( String & name )

Specifies the name of a condition.

Parameters

name	Condition name

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

Specifies the properties of the Vector type.

The unit that is currently being used is used.

Parameters

propName	Property name
value	Point object

void Condition::SetPointWithUnit	(	String &	propName,
		Point *	value,
		String &	unitName
	)

Specifies the properties of the Vector type by specifying the unit.

The unit that is currently in use is used without referencing the unit of the value.

Parameters

propName	Property name
value	Point object
unitName	Unit

void ParameterList::SetTable	(	String &	propName,
		String array &	mat
	)

inherited

Specifies the value in the specified table for the properties.

Parameters

propName	Property name
mat	Multidimensional array

void ParameterList::SetTableFromFile	(	String &	propName,
		String &	filename
	)

inherited

Specifies a point sequence for a property that is specified, by importing a point sequence file (*.csv, *.txt, *.pa).

Parameters

propName	Property name
filename	Path for file that is imported

The following are example. Creates electric current condition and specifies point sequence for the time dependency current by using a file.

Set cond = study.CreateCondition("Current","current")
Call cond.SetValue("XType","Time")
Call cond.SetTableFromFile("Time","D:\sample_read_csv.csv")

The following file formats can be imported.

CSV file (*.csv):
This file can be edited using Microsoft Excel.
Text file (*.txt):
Point sequence file (*.pa)
This is table data that can be exported by JMAG-Studio.

void ParameterList::SetTableList	(	String &	propName,
		double	primaryKey,
		String &	primaryUnitName,
		String array &	mat
	)

inherited

Specifies the name for the dataset list (multiple tables).

Parameters

propName	Property name
primaryKey	Value of the primary key
primaryUnitName	Unit name of the primary key
mat	Multidimensional array

void ParameterList::SetTableListName	(	String &	propName,
		String &	name
	)

inherited

Specifies the name for the dataset list (multiple tables).

Parameters

propName	Property name
name	Dataset list name

void ParameterList::SetTableListWithDualKey	(	String &	propName,
		double	primaryKey,
		String &	primaryUnitName,
		double	secondaryKey,
		String &	secondaryUnitName,
		String array &	mat
	)

inherited

Specifies a point sequence for the multidimensional array of the specified primary key and secondary key in the dataset list (multiple tables).

Parameters

propName	Property name
primaryKey	Value of the primary key
primaryUnitName	Unit name of the primary key
secondaryKey	Value of the secondary key
secondaryUnitName	Unit name of the secondary key
mat	Multidimensional array

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

inherited

Specifies a table for the specified properties.

Parameters

propName	Property name
set	DataSet (table)

void ParameterList::SetTableWithUnit	(	String &	propName,
		String array &	mat,
		StringList &	unitlist
	)

inherited

Specifies the value of the specified table property.

Parameters

propName	Property name
mat	Multidimensional array
unitlist	Unit list

void ParameterList::SetTextTable	(	String &	propName,
		String array &	mat
	)

inherited

Specifies the value in the specified string table for the properties.

Parameters

propName	Property name
mat	String multidimensional array

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

virtualinherited

Specifies the value of the real number property or flag property.

The unit that is currently being used is used. A real number value is converted into an integer for the flag property.

Parameters

propName	Property name
value	Property value

Reimplemented in CircuitComponent, and StudyProperties.

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

virtualinherited

Specifies the value of the named property.

The unit that is currently being used is used. A real number value is converted into an integer for the flag property.

Parameters

propName	Property name
value	Property value
unitName	Unit

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

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

Parameters

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

void Condition::SetXYZPointWithUnit	(	String &	propName,
		double	x,
		double	y,
		double	z,
		String &	unitName
	)

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

Parameters

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

Public Member Functions

Detailed Description

Member Function Documentation