Condition クラスは条件の設定に使用します。
Study クラスから呼び出すことができます。
. [詳解]

ParameterListを継承しています。

公開メンバ関数
void	AddGroup (MeshGroup *set, int group)
	指定された名称またはインデックスをもつ MeshGroup オブジェクトを、条件の設定グループに追加します。 [詳解]

void	AddPart (Variant &val)
	指定された名称またはIDをもつ、部品、面、またはエッジを設定グループに追加します。 [詳解]

void	AddPartByGroup (Variant &val, int group)
	指定された設定グループに、新しく部品、面、またはエッジを追加します。 [詳解]

void	AddPartByTargetType (Variant &val, String &targetTypeName)
	条件によって、設定対象の種類（部品、面、エッジ）を選択できるものがあります（マルチオブジェクト）。このコマンドでは、設定グループへ追加する対象を、種類（部品、面、エッジ）と名称またはIDで指定します。 [詳解]

void	AddSecondaryPart (Variant &val)
	条件に2つの設定グループがある場合に、2番目の設定グループに、部品、面、またはエッジを追加します。 [詳解]

void	AddSecondarySelected (Selection *selection)
	Selection オブジェクトで選択されている部品、面、またはエッジを、条件の設定グループに追加します。 [詳解]

void	AddSelected (Selection *selection)
	Selection オブジェクトで選択されている部品、面、またはエッジを、条件の設定グループに追加します。 [詳解]

void	AddSelectedByGroup (Selection *Selection, int group)
	Selection オブジェクトで選択されている部品、面、またはエッジを、指定された設定グループに追加します。 [詳解]

void	AddSet (Set *set, int group)
	指定された名称またはインデックスをもつセットを、条件の設定グループに追加します。 [詳解]

void	AddSetFromModel (Variant &val, int group)
	指定されたモデル名またはインデックスを持つモデルを、条件の設定グループに追加します。 [詳解]

void	AddSubCondition (Variant &val, int subIndex)
	条件を指定して、条件に下位条件を挿入します。 [詳解]

void	AddTarget (String &name)
	設定対象に任意断面・任意エッジを追加します。 [詳解]

double	CalculateInertiaValue ()
	慣性モーメント/質量を計算して取得します。 [詳解]

void	ClearParts ()
	条件の設定対象から、すべての部品、面、またはエッジを除きます。

void	ClearPartsByGroup (int group)
	条件の設定対象から、すべての部品、面、またはエッジを除きます。 [詳解]

void	ClearTargets ()
	設定対象から、全ての任意断面・任意エッジを外します。

Condition *	CreateSubCondition (String &typeName, String &name)
	指定されたタイプ名と名称によって Condition オブジェクトを取得します。 [詳解]

int	GetCoordinateSystemIndex (String &propName)
	座標系プロパティをインデックスで取得します。 [詳解]

String	GetCoordinateSystemName (String &propName)
	座標系プロパティを名称で取得します。 [詳解]

virtual String	GetFlagAsString (String &name)
	指定したプロパティの設定を、フラグプロパティ名で取得します。 [詳解]

virtual String	GetFlagPropertyHelp (String &propName, Variant &val)
	名称またはインデックスを指定して、フラグプロパティのヘルプを文字列として取得します。 [詳解]

FunctionObject *	GetFunction ()
	条件用に FunctionObject オブジェクトを取得します。 [詳解]

String	GetInstanceLink (String &propName)
	条件と関連付けられた回路素子の名称を取得します。 [詳解]

Variant	GetKeyNames (String &name)
	指定したプロパティで設定可能なフラグの一覧を取得します。 [詳解]

String	GetLink ()
	条件に関連付けられた回路素子の名称を取得します。 [詳解]

String	GetLinkWithType (String &type)
	条件に関連付けられた条件または回路素子の名称を取得します。 [詳解]

Material *	GetMaterial (String &propName)
	レイヤーメッシュの電磁鋼板部分または絶縁層部分に割り当てられた材料を取得します。 [詳解]

String	GetName ()
	条件の名称を、文字列で取得します。 [詳解]

Variant	GetParts ()
	部品、面、またはエッジのIDのリストを、点列形式で取得します。 [詳解]

Variant	GetPartsByGroup (int group)
	指定された設定グループに含まれる、部品、面、またはエッジのIDのリストを点列形式で取得します。 [詳解]

Point *	GetPoint (String &propName)
	Typeが"Vector"のプロパティの値を Point オブジェクトとして取得します。 [詳解]

Point *	GetPointWithUnit (String &propName, String &unitName)
	Typeが"Vector"のプロパティの値を、Point オブジェクトとして単位指定で取得します。 [詳解]

virtual String	GetPropertyHelp (String &propName)
	プロパティのヘルプを文字列として取得します。 [詳解]

Variant	GetPropertyNames ()
	条件中で設定可能な全プロパティの名称リストを取得します。 [詳解]

String	GetPropertyTable ()
	タイプ、ヘルプを含むプロパティの一覧を取得します。 [詳解]

virtual String	GetPropertyType (String &propName)
	プロパティの型を取得します。 [詳解]

ReferenceTarget *	GetReferenceTarget (String &propName)
	指定されたプロパティの参照ターゲットの値を取得します。 [詳解]

String	GetScriptTypeName ()
	条件のタイプ名の文字列を取得します。 [詳解]

Variant	GetSecondaryParts ()
	条件に2つの設定グループがある場合に、2番目の設定グループの部品、面、またはエッジのIDのリストを、点列形式で取得します。 [詳解]

Selection *	GetSecondarySelection ()
	条件に2つの設定グループがある場合に、2番目の設定グループの部品、面、またはエッジを Selection オブジェクトとして取得します。 [詳解]

Selection *	GetSelection ()
	条件の設定グループに含まれる部品、面、またはエッジを、Selection オブジェクトとして取得します。 [詳解]

Selection *	GetSelectionByGroup (int group)
	指定された設定グループに含まれるすべての部品、面、またはエッジを Selection オブジェクトとして取得します。 [詳解]

Set *	GetSet (int index, int group)
	指定されたインデックスをもつ条件の設定グループに含まれるセットを取得します。 [詳解]

virtual String	GetStringValue (String &propName)
	プロパティの値を文字列で取得します。 [詳解]

Condition *	GetSubCondition (Variant &val)
	名称またはインデックスを指定して、下位条件の Condition オブジェクトを取得します。 [詳解]

DataSet *	GetTable (String &propName)
	指定したプロパティの点列を取得します。 [詳解]

DataSetList *	GetTableList (String &propName)
	指定したプロパティの点列リストの値を取得します。 [詳解]

String	GetType ()
	条件の名称を文字列で取得します。 [詳解]

virtual double	GetValue (String &propName)
	プロパティの値を実数で取得します。 [詳解]

virtual double	GetValueWithUnit (String &propName, String &unitName)
	プロパティの値を単位指定で実数で取得します。 [詳解]

bool	HasTargetOnXYPlane (double tolerance=1e-6)
	設定対象の中にXY平面上に属するものが存在するか否かを取得します。 [詳解]

bool	HasTargetOnYZPlane (double tolerance=1e-6)
	設定対象の中にYZ平面上に属するものが存在するか否かを取得します。 [詳解]

bool	HasTargetOnZXPlane (double tolerance=1e-6)
	設定対象の中にZX平面上に属するものが存在するか否かを取得します。 [詳解]

void	InsertSubCondition (Condition *condition, int subIndex)
	Condition オブジェクトを指定して、条件に下位条件を挿入します。 [詳解]

void	InsertSubConditionByIndex (int conditionIndex, int subIndex)

virtual bool	IsValid ()
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]

bool	NodeIsOnTarget (int nodeId, double tolerance=1e-6)
	これは内部関数であるため、正式にサポートしていません。 [詳解]

int	NumSets (int group)
	指定された名称またはインデックスをもつ条件の設定グループに含まれるセット数を取得します。 [詳解]

int	NumSubConditions ()
	下位条件の数を整数で取得します。 [詳解]

void	RemoveAllSets (int group)
	全てのセットを、条件の設定グループから外します。 [詳解]

void	RemovePart (int id)
	設定グループから、特定の部品、面、またはエッジを除きます。 [詳解]

void	RemovePartByGroup (int id, int group)
	指定された設定グループに含まれる部品、面、またはエッジの中から、指定されたIDをもつものを除きます。 [詳解]

void	RemovePartByTargetType (int id, String &targetTypeName)
	条件によって、設定対象の種類（部品、面、エッジ）を選択できるものがあります（マルチオブジェクト）。このコマンドでは、設定グループから削除する対象を、種類（部品、面、エッジ）、および、IDまたは名称で指定します。 [詳解]

void	RemoveSecondaryPart (int id)
	条件に2つの設定グループがある場合に、2番目の設定グループから、部品、面、またはエッジを除きます。 [詳解]

void	RemoveSet (Variant &val, int group)
	指定された名称またはインデックスをもつセットを、条件の設定グループから外します。 [詳解]

void	RemoveSubCondition (Variant &val)
	名称またはインデックスによって、下位条件を削除します。 [詳解]

virtual void	SetComplexValue (String &propName, double real, double imag)
	複素数を設定します。 [詳解]

void	SetCoordinateSystem (String &propName, Variant &val)
	座標系プロパティを設定します。 [詳解]

void	SetDirectionFromReferenceTarget (String &propName, ReferenceTarget *ref, String &directionType=String())
	参照ターゲットから条件の方向のプロパティを設定します。 [詳解]

virtual void	SetFlagByName (String &propName, String &scriptKeyName)
	名称を指定して、フラグプロパティの値を設定します。 [詳解]

void	SetFunction (FunctionObject *func)
	プロパティに指定された関数の値を設定します。 [詳解]

void	SetInstanceLink (String &propName, Variant &val)
	条件と関連付ける回路素子を指定します。 [詳解]

void	SetLink (String &name)
	条件に関連付ける回路素子を設定します。 [詳解]

void	SetLinkWithType (Variant &type, Variant &val)
	関連付ける条件または回路素子を設定します。 [詳解]

void	SetMaterial (String &propName, Material *material)
	変数を使って、レイヤーメッシュの電磁鋼板部分または絶縁層部分に材料を割り当てます。 [詳解]

void	SetMaterialByName (String &propName, String &matname)
	材料名を使って、レイヤーメッシュの電磁鋼板部分または絶縁層部分に材料を割り当てます。 [詳解]

void	SetName (String &name)
	条件の名称を設定します。 [詳解]

void	SetPoint (String &propName, Point *value)
	Typeが"Vector"のプロパティを設定します。 [詳解]

void	SetPointWithUnit (String &propName, Point *value, String &unitName)
	Typeが"Vector"のプロパティを単位指定で設定します。 [詳解]

void	SetTable (String &propName, String array &mat)
	指定した点列の値をプロパティに設定します。 [詳解]

void	SetTableFromFile (String &propName, String &filename)
	点列ファイル（.csv, .txt, *.pa）をインポートして、指定したプロパティに点列を設定します。 [詳解]

void	SetTableList (String &propName, double primaryKey, String &primaryUnitName, String array &mat)
	データセットリスト（複数点列）の指定された第1キーに多次元配列の点列を設定します。 [詳解]

void	SetTableListName (String &propName, String &name)
	データセットリスト（複数点列）の名称を設定します。 [詳解]

void	SetTableListWithDualKey (String &propName, double primaryKey, String &primaryUnitName, double secondaryKey, String &secondaryUnitName, String array &mat)
	データセットリスト（複数点列）の指定された第1キーに多次元配列の点列を設定します。 [詳解]

void	SetTableProperty (String &propName, DataSet *set)
	指定したプロパティに、点列を設定します。 [詳解]

void	SetTableWithUnit (String &propName, String array &mat, StringList &unitlist)
	指定した点列の値を単位指定でプロパティに設定します。 [詳解]

void	SetTextTable (String &propName, String array &mat)
	指定した文字列テーブルの値をプロパティに設定します。 [詳解]

virtual void	SetValue (String &propName, Variant &value)
	実数またはフラグのプロパティの値を設定します。値の単位は考慮されずに、現在使用中の単位が使用されます。 [詳解]

virtual void	SetValueWithUnit (String &propName, double value, String &unitName)
	実数またはフラグのプロパティの値を単位指定で設定します。 [詳解]

void	SetXYZPoint (String &propName, Variant &x, Variant &y, Variant &z)
	Point型のプロパティを x y z で指定します。 [詳解]

void	SetXYZPointWithUnit (String &propName, double x, double y, double z, String &unitName)
	Point型のプロパティを x y z で単位指定で指定します。 [詳解]

詳解

Condition クラスは条件の設定に使用します。
Study クラスから呼び出すことができます。
.

このクラスのオブジェクトを取得する例:

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

また、各条件に付随するプロパティの指定には、条件設定で使用するものに掲載するプロパティ名およびフラグを使用します。

関数詳解

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

指定された名称またはインデックスをもつ MeshGroup オブジェクトを、条件の設定グループに追加します。

引数

set	MeshGroup オブジェクトの名称またはインデックス
group	条件の設定グループ番号

void Condition::AddPart ( Variant & val )

指定された名称またはIDをもつ、部品、面、またはエッジを設定グループに追加します。

引数

val	部品、面、エッジの名称またはID

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

指定された設定グループに、新しく部品、面、またはエッジを追加します。

引数

val	部品、面、エッジの名称またはID
group	設定グループ番号

このコマンドは、1つの設定画面に複数のリストボックスがあるような設定をする際に使用されます。
たとえば、［部品の親子関係］ダイアログの［親部品］ボックスには、設定グループ番号（group）として「0」が割り当てられています。
同様に、［子部品（反転なし）］ボックスは「group=1」、［子部品（反転あり）］ボックスは「group=2」がそれぞれ割り当てられています。

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

条件によって、設定対象の種類（部品、面、エッジ）を選択できるものがあります（マルチオブジェクト）。このコマンドでは、設定グループへ追加する対象を、種類（部品、面、エッジ）と名称またはIDで指定します。

引数

val	部品、面、エッジの名称またはID
targetTypeName	種類 Face：面 Part：部品 Edge：エッジ

void Condition::AddSecondaryPart ( Variant & val )

条件に2つの設定グループがある場合に、2番目の設定グループに、部品、面、またはエッジを追加します。

引数

val	部品、面、エッジの名称またはID

void Condition::AddSecondarySelected ( Selection * selection )

Selection オブジェクトで選択されている部品、面、またはエッジを、条件の設定グループに追加します。

引数

selection Selection オブジェクト（選択中の部品、面、エッジ）

void Condition::AddSelected ( Selection * selection )

Selection オブジェクトで選択されている部品、面、またはエッジを、条件の設定グループに追加します。

引数

selection Selection（選択中の部品、面、エッジ）

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

Selection オブジェクトで選択されている部品、面、またはエッジを、指定された設定グループに追加します。

引数

selection	Selection（選択中の部品、面、エッジ）
group	設定グループ番号

group（設定グループ番号）については、 AddPartByGroup() の説明を参照してください。

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

指定された名称またはインデックスをもつセットを、条件の設定グループに追加します。

引数

set	セットの名称またはインデックス
group	条件の設定グループ番号

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

指定されたモデル名またはインデックスを持つモデルを、条件の設定グループに追加します。

引数

val	モデルの名称またはインデックス
group	条件の設定グループ番号

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

条件を指定して、条件に下位条件を挿入します。

引数

val	挿入する条件のインデックスまたは名称
subIndex	下位条件のインデックス

void Condition::AddTarget ( String & name )

設定対象に任意断面・任意エッジを追加します。

引数

name 計算対象の名前

double Condition::CalculateInertiaValue ( )

慣性モーメント/質量を計算して取得します。

戻り値: 慣性モーメント/質量

void Condition::ClearPartsByGroup ( int group )

条件の設定対象から、すべての部品、面、またはエッジを除きます。

引数

group 設定グループ番号

group（設定グループ番号）については、 AddPartByGroup() の説明を参照してください。

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

指定されたタイプ名と名称によって Condition オブジェクトを取得します。

FEMコイル条件でグループ(下位条件)を作成する場合に使用します。

引数

typeName	条件タイプ名
name	条件名

戻り値: Condition オブジェクト

typeName として指定可能な条件タイプ名については、磁界解析で指定できるプロパティを参照してください。

int Condition::GetCoordinateSystemIndex ( String & propName )

座標系プロパティをインデックスで取得します。

引数

propName プロパティ名

戻り値: 座標系のインデックス

String Condition::GetCoordinateSystemName ( String & propName )

座標系プロパティを名称で取得します。

引数

propName プロパティ名

戻り値: 座標系名

String ParameterList::GetFlagAsString ( String & name )

virtualinherited

指定したプロパティの設定を、フラグプロパティ名で取得します。

引数

name プロパティ名

戻り値: DataSet オブジェクト（プロパティの点列）

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

virtualinherited

名称またはインデックスを指定して、フラグプロパティのヘルプを文字列として取得します。

引数

propName	プロパティ名
val	フラグの名称またはインデックス

戻り値: フラグプロパティのヘルプ

FunctionObject * Condition::GetFunction ( )

条件用に FunctionObject オブジェクトを取得します。

戻り値: FunctionObject オブジェクト

String Condition::GetInstanceLink ( String & propName )

条件と関連付けられた回路素子の名称を取得します。

次のパターンがあります。

発熱量条件と抵抗素子
発熱素子条件と発熱素子
温度分布条件と温度プローブ素子

引数

propName

ResistorID ： 抵抗素子のID
HeatGenerationComponentId ： 発熱素子のID
ThermalProbeID ： 温度プローブ素子のID

戻り値: 回路素子の名称

Variant ParameterList::GetKeyNames ( String & name )

inherited

指定したプロパティで設定可能なフラグの一覧を取得します。

引数

name プロパティ名

戻り値: フラグ一覧

String Condition::GetLink ( )

条件に関連付けられた回路素子の名称を取得します。

戻り値: 回路素子名

回路素子については Circuit クラス、 CircuitComponent クラス、 CircuitComponentInstance クラス、 CircuitWire クラスおよび回路の設定で使用するものを参照してください。

String Condition::GetLinkWithType ( String & type )

条件に関連付けられた条件または回路素子の名称を取得します。

引数

type	タイプ名 Resistance ：抵抗素子 FEMCoil ： FEMコイル条件

戻り値: 条件名・回路素子名

SetLinkWithType() および GetLinkWithType() は、磁界解析の発熱量条件にのみ対応しています。

Material * Condition::GetMaterial ( String & propName )

レイヤーメッシュの電磁鋼板部分または絶縁層部分に割り当てられた材料を取得します。

引数

propName

SteelSheetMaterial ：電磁鋼板部分の材料

InsulationMaterial ：絶縁層部分の材料

戻り値: Material オブジェクト

String Condition::GetName ( )

条件の名称を、文字列で取得します。

戻り値: 条件名

Variant Condition::GetParts ( )

部品、面、またはエッジのIDのリストを、点列形式で取得します。

戻り値: 部品/面/エッジのIDリスト

Variant Condition::GetPartsByGroup ( int group )

指定された設定グループに含まれる、部品、面、またはエッジのIDのリストを点列形式で取得します。

引数

group 設定グループ番号

戻り値: 部品,面,エッジのIDリスト

group（設定グループ番号）については、 AddPartByGroup() の説明を参照してください。

Point * Condition::GetPoint ( String & propName )

Typeが"Vector"のプロパティの値を Point オブジェクトとして取得します。

引数

propName プロパティ名

戻り値: Point オブジェクト

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

Typeが"Vector"のプロパティの値を、Point オブジェクトとして単位指定で取得します。

引数

propName プロパティ名

戻り値: Point オブジェクト

引数

unitName 単位

String ParameterList::GetPropertyHelp ( String & propName )

virtualinherited

プロパティのヘルプを文字列として取得します。

引数

propName プロパティ名

戻り値: プロパティのヘルプ

Variant ParameterList::GetPropertyNames ( )

inherited

条件中で設定可能な全プロパティの名称リストを取得します。

戻り値: 条件中のプロパティ名

String ParameterList::GetPropertyTable ( )

inherited

タイプ、ヘルプを含むプロパティの一覧を取得します。

戻り値: プロパティの一覧

String ParameterList::GetPropertyType ( String & propName )

virtualinherited

プロパティの型を取得します。

引数

propName プロパティ名

戻り値: プロパティのタイプ

ReferenceTarget * Condition::GetReferenceTarget ( String & propName )

指定されたプロパティの参照ターゲットの値を取得します。

引数

propName プロパティ名

戻り値: ReferenceTarget オブジェクト

String Condition::GetScriptTypeName ( )

条件のタイプ名の文字列を取得します。

戻り値: 条件のタイプ名

条件設定のプロパティ名については、条件設定で使用するものを参照してください。

Variant Condition::GetSecondaryParts ( )

条件に2つの設定グループがある場合に、2番目の設定グループの部品、面、またはエッジのIDのリストを、点列形式で取得します。

戻り値: 部品、面、エッジのIDリスト

Selection * Condition::GetSecondarySelection ( )

条件に2つの設定グループがある場合に、2番目の設定グループの部品、面、またはエッジを Selection オブジェクトとして取得します。

戻り値: Selection オブジェクト

Selection * Condition::GetSelection ( )

条件の設定グループに含まれる部品、面、またはエッジを、Selection オブジェクトとして取得します。

戻り値: Selection オブジェクト

Selection * Condition::GetSelectionByGroup ( int group )

指定された設定グループに含まれるすべての部品、面、またはエッジを Selection オブジェクトとして取得します。

引数

group 設定グループ番号

戻り値: Selection オブジェクト

group（設定グループ番号）については AddPartByGroup() の説明を参照してください。

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

指定されたインデックスをもつ条件の設定グループに含まれるセットを取得します。

引数

index	インデックス
group	条件の設定グループ番号

String ParameterList::GetStringValue ( String & propName )

virtualinherited

プロパティの値を文字列で取得します。

引数

propName プロパティ名

戻り値: プロパティの値

StudyPropertiesで再実装されています。

Condition * Condition::GetSubCondition ( Variant & val )

名称またはインデックスを指定して、下位条件の Condition オブジェクトを取得します。

引数

val	条件の名称またはインデックス

戻り値: Condition オブジェクト

DataSet * ParameterList::GetTable ( String & propName )

inherited

指定したプロパティの点列を取得します。

引数

propName プロパティ名

戻り値: DataSet （点列）

DataSetList * ParameterList::GetTableList ( String & propName )

inherited

指定したプロパティの点列リストの値を取得します。

引数

propName プロパティ名

戻り値: DataSetList （点列リスト）

String Condition::GetType ( )

条件の名称を文字列で取得します。

戻り値: 条件の名称

このコマンドでの「条件の名称」とは、JMAG-Designerのプロジェクトマネージャに表示される条件の名称のことです。
たとえば、「運動：回転」、「周期境界（回転）」、「トルク：節点力」などが返ります。

double ParameterList::GetValue ( String & propName )

virtualinherited

プロパティの値を実数で取得します。

引数

propName プロパティ名

戻り値: プロパティの値

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

virtualinherited

プロパティの値を単位指定で実数で取得します。

引数

propName	プロパティ名
unitName	単位

戻り値: プロパティの値

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

設定対象の中にXY平面上に属するものが存在するか否かを取得します。

引数

tolerance トレランス

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

設定対象の中にYZ平面上に属するものが存在するか否かを取得します。

引数

tolerance トレランス

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

設定対象の中にZX平面上に属するものが存在するか否かを取得します。

引数

tolerance トレランス

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

Condition オブジェクトを指定して、条件に下位条件を挿入します。

引数

condition	Condition オブジェクト
subIndex	下位条件のインデックス

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

非推奨:

インデックスを指定して、条件に下位条件を挿入します。

引数

conditionIndex	挿入する条件のインデックス
subIndex	下位条件のインデックス

bool ParameterList::IsValid ( )

virtualinherited

オブジェクトが有効であるとき、戻り値として True を取得します。

戻り値: ParameterList オブジェクトの有効・無効

MaterialObject, CircuitComponent, StudyProperties, Stepで再実装されています。

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

これは内部関数であるため、正式にサポートしていません。

非推奨:

int Condition::NumSets ( int group )

指定された名称またはインデックスをもつ条件の設定グループに含まれるセット数を取得します。

引数

group 条件の設定グループ番号

戻り値: セット数

int Condition::NumSubConditions ( )

下位条件の数を整数で取得します。

戻り値: スタディ中の条件の数

void Condition::RemoveAllSets ( int group )

全てのセットを、条件の設定グループから外します。

引数

group 条件の設定グループ番号

void Condition::RemovePart ( int id )

設定グループから、特定の部品、面、またはエッジを除きます。

引数

id	部品/面/エッジのID

部品ID、面ID、エッジIDについては、「［ID情報］」を参照してください。

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

指定された設定グループに含まれる部品、面、またはエッジの中から、指定されたIDをもつものを除きます。

引数

id	部品, 面, エッジのID
group	設定グループ番号

group（設定グループ番号）については、 AddPartByGroup() の説明を参照してください。

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

条件によって、設定対象の種類（部品、面、エッジ）を選択できるものがあります（マルチオブジェクト）。このコマンドでは、設定グループから削除する対象を、種類（部品、面、エッジ）、および、IDまたは名称で指定します。

引数

id	部品, 面, エッジのID
targetTypeName	設定対象の種類 Face ：面 Part ：部品 Edge ：エッジ

group（設定グループ番号）については、 AddPartByGroup() の説明を参照してください。

void Condition::RemoveSecondaryPart ( int id )

条件に2つの設定グループがある場合に、2番目の設定グループから、部品、面、またはエッジを除きます。

引数

id	部品、面、またはエッジのID

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

指定された名称またはインデックスをもつセットを、条件の設定グループから外します。

引数

val	セットの名称またはインデックス
group	条件の設定グループ番号

void Condition::RemoveSubCondition ( Variant & val )

名称またはインデックスによって、下位条件を削除します。

戻り値: 条件の名称またはインデックス

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

virtualinherited

複素数を設定します。

値の単位は考慮されずに、現在使用中の単位が使用されます。プロパティがフラグプロパティの場合、実数の値は整数に変換されます。

引数

propName	プロパティ名
real	プロパティの値（実数）
imag	プロパティの値（虚数）

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

座標系プロパティを設定します。

引数

propName	プロパティ名
val	座標系名またはインデックス

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

参照ターゲットから条件の方向のプロパティを設定します。

引数

propName	プロパティ名
ref	ReferenceTarget オブジェクト
directionType	エッジのターゲットの指定方法 arc ：円弧 perpendicular ：垂直 (空白) ：指定なし

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

virtualinherited

名称を指定して、フラグプロパティの値を設定します。

引数

propName	プロパティ名
scriptKeyName	フラグの名称

void Condition::SetFunction ( FunctionObject * func )

プロパティに指定された関数の値を設定します。

引数

func	FunctionObject オブジェクト

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

条件と関連付ける回路素子を指定します。

次のパターンがあります。

発熱量条件と抵抗素子
発熱素子条件と発熱素子
温度分布条件と温度プローブ素子

引数

propName	タイプ名 ResistorID ：抵抗素子のID HeatGenerationComponentId ：発熱素子のID ThermalProbeID ：温度プローブ素子のID
val	素子の名称、またはインデックス

void Condition::SetLink ( String & name )

条件に関連付ける回路素子を設定します。

引数

name 回路素子名

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

関連付ける条件または回路素子を設定します。

引数

type	タイプ名 Resistance ：抵抗素子 FEMCoil ： FEMコイル条件
val	条件名・回路素子の名称、またはインデックス

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

変数を使って、レイヤーメッシュの電磁鋼板部分または絶縁層部分に材料を割り当てます。

引数

propName	SteelSheetMaterial ：電磁鋼板部分の材料 InsulationMaterial ：絶縁層部分の材料
material	Material オブジェクト

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

材料名を使って、レイヤーメッシュの電磁鋼板部分または絶縁層部分に材料を割り当てます。

引数

propName	SteelSheetMaterial ：電磁鋼板部分の材料 InsulationMaterial ：絶縁層部分の材料
matname	材料名

void Condition::SetName ( String & name )

条件の名称を設定します。

引数

name 条件名

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

Typeが"Vector"のプロパティを設定します。

値の単位は考慮されずに、現在使用中の単位が使用されます。

引数

propName	プロパティ名
value	Point オブジェクト

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

Typeが"Vector"のプロパティを単位指定で設定します。

値の単位は考慮されずに、現在使用中の単位が使用されます。

引数

propName	プロパティ名
value	Point オブジェクト
unitName	単位

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

inherited

指定した点列の値をプロパティに設定します。

引数

propName	プロパティ名
mat	多次元配列

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

inherited

点列ファイル（*.csv, *.txt, *.pa）をインポートして、指定したプロパティに点列を設定します。

引数

propName	プロパティ名
filename	インポートするファイルのパス

以下は使用例です。電流条件を作成し、時刻依存性電流点列をファイルを用いて指定します。

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

次の形式のファイルをインポートすることができます

CSVファイル（*.csv）：
Microsoft Excelで編集可能なファイルです。
テキストファイル（*.txt）
点列ファイル（*.pa）：
JMAG-Studioでエクスポート可能な点列データファイルです。

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

inherited

データセットリスト（複数点列）の指定された第1キーに多次元配列の点列を設定します。

引数

propName	プロパティ名
primaryKey	第1キーの値
primaryUnitName	第1キーの単位名
mat	多次元配列

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

inherited

データセットリスト（複数点列）の名称を設定します。

引数

propName	プロパティ名
name	データセットリスト名

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

inherited

データセットリスト（複数点列）の指定された第1キーに多次元配列の点列を設定します。

引数

propName	プロパティ名
primaryKey	第1キーの値
primaryUnitName	第1キーの単位名
secondaryKey	第2キーの値
secondaryUnitName	第2キーの単位名
mat	多次元配列

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

inherited

指定したプロパティに、点列を設定します。

引数

propName	プロパティ名
set	DataSet （点列）

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

inherited

指定した点列の値を単位指定でプロパティに設定します。

引数

propName	プロパティ名
mat	多次元配列
unitlist	単位リスト

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

inherited

指定した文字列テーブルの値をプロパティに設定します。

引数

propName	プロパティ名
mat	文字列テーブルデータ（多次元配列）

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

virtualinherited

実数またはフラグのプロパティの値を設定します。値の単位は考慮されずに、現在使用中の単位が使用されます。

プロパティがフラグプロパティの場合、実数の値は整数に変換されます。

引数

propName	プロパティ名
value	プロパティの値

CircuitComponent, StudyPropertiesで再実装されています。

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

virtualinherited

実数またはフラグのプロパティの値を単位指定で設定します。

値の単位は考慮されずに、現在使用中の単位が使用されます。プロパティがフラグプロパティの場合、実数の値は整数に変換されます。

引数

propName	プロパティ名
value	プロパティの値
unitName	単位

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

Point型のプロパティを x y z で指定します。

引数

propName	プロパティ名
x	X座標
y	Y座標
z	Z座標

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

Point型のプロパティを x y z で単位指定で指定します。

引数

propName	プロパティ名
x	X座標
y	Y座標
z	Z座標
unitName	単位

公開メンバ関数

詳解

関数詳解