Step クラス

Step クラスはステップコントロールの設定で使用します。
Study クラスから呼び出すことができます。
. [詳解]

ParameterListを継承しています。

公開メンバ関数
void	AddSubCondition (Variant &val, int subIndex)
	条件を指定して、定常判定条件を挿入します。 [詳解]
Condition *	CreateSubCondition (String &typeName, String &name)
	指定されたタイプ名と名称によって Condition オブジェクトを取得します。 [詳解]
virtual String	GetFlagAsString (String &name)
	指定したプロパティの設定を、フラグプロパティ名で取得します。 [詳解]
virtual String	GetFlagPropertyHelp (String &propName, Variant &val)
	名称またはインデックスを指定して、フラグプロパティのヘルプを文字列として取得します。 [詳解]
String	GetInstanceLink (String &propName)
	ステップコントロールと関連付けられた回路素子の名称を取得します。 [詳解]
Variant	GetKeyNames (String &name)
	指定したプロパティで設定可能なフラグの一覧を取得します。 [詳解]
String	GetLinkWithType (String &type)
	ステップコントロールに関連付けられた条件または回路素子の名称を取得します。 [詳解]
virtual String	GetPropertyHelp (String &propName)
	プロパティのヘルプを文字列として取得します。 [詳解]
Variant	GetPropertyNames ()
	条件中で設定可能な全プロパティの名称リストを取得します。 [詳解]
String	GetPropertyTable ()
	タイプ、ヘルプを含むプロパティの一覧を取得します。 [詳解]
virtual String	GetPropertyType (String &propName)
	プロパティの型を取得します。 [詳解]
virtual String	GetStringValue (String &propName)
	プロパティの値を文字列で取得します。 [詳解]
Condition *	GetSubCondition (Variant &val)
	名称またはインデックスを指定して、定常判定条件の Condition オブジェクトを取得します。 [詳解]
DataSet *	GetTable (String &propName)
	指定したプロパティの点列を取得します。 [詳解]
DataSetList *	GetTableList (String &propName)
	指定したプロパティの点列リストの値を取得します。 [詳解]
virtual double	GetValue (String &propName)
	プロパティの値を実数で取得します。 [詳解]
virtual double	GetValueWithUnit (String &propName, String &unitName)
	プロパティの値を単位指定で実数で取得します。 [詳解]
void	InsertSubCondition (Condition *condition, int subIndex)
	Condition オブジェクトを指定して、定常判定条件を挿入します。 [詳解]
void	InsertSubConditionByIndex (int conditionIndex, int subIndex)
bool	IsValid ()
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
int	NumSubConditions ()
	定常判定条件の数を整数で取得します。 [詳解]
void	RemoveSubCondition (Variant &val)
	名称またはインデックスによって、定常判定条件を削除します。 [詳解]
virtual void	SetComplexValue (String &propName, double real, double imag)
	複素数を設定します。 [詳解]
virtual void	SetFlagByName (String &propName, String &scriptKeyName)
	名称を指定して、フラグプロパティの値を設定します。 [詳解]
void	SetInstanceLink (String &propName, Variant &val)
	ステップコントロールと関連付ける回路素子を指定します。 [詳解]
void	SetLinkWithType (Variant &type, Variant &val)
	関連付ける条件または回路素子を設定します。 [詳解]
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)
	実数またはフラグのプロパティの値を単位指定で設定します。 [詳解]

詳解

Step クラスはステップコントロールの設定で使用します。
Study クラスから呼び出すことができます。
.

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

app.GetModel(0).GetStudy().GetStep()

Stepで設定するプロパティについては以下を参照してください。

• "ステップコントロール"
• "周波数コントロール"

関数詳解

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

条件を指定して、定常判定条件を挿入します。

引数

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

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

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

定常判定条件を作成する場合に使用します。

引数

typeName	条件タイプ名
name	条件名

戻り値

Condition オブジェクト

引数"typeName"として指定可能な条件タイプ名は、"SteadyState"のみです。

String ParameterList::GetFlagAsString ( String &  name )

virtualinherited

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

引数

name

プロパティ名

戻り値

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

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

virtualinherited

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

引数

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

戻り値

フラグプロパティのヘルプ

String Step::GetInstanceLink

(

String &

propName

)

ステップコントロールと関連付けられた回路素子の名称を取得します。

引数

propName

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

戻り値

回路素子の名称

Variant ParameterList::GetKeyNames ( String &  name )

inherited

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

引数

name

プロパティ名

戻り値

フラグ一覧

String Step::GetLinkWithType

(

String &

type

)

ステップコントロールに関連付けられた条件または回路素子の名称を取得します。

引数

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

戻り値

条件名・回路素子名

String ParameterList::GetPropertyHelp ( String &  propName )

virtualinherited

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

引数

propName

プロパティ名

戻り値

プロパティのヘルプ

Variant ParameterList::GetPropertyNames ( )

inherited

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

戻り値

条件中のプロパティ名

String ParameterList::GetPropertyTable ( )

inherited

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

戻り値

プロパティの一覧

String ParameterList::GetPropertyType ( String &  propName )

virtualinherited

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

引数

propName

プロパティ名

戻り値

プロパティのタイプ

String ParameterList::GetStringValue ( String &  propName )

virtualinherited

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

引数

propName

プロパティ名

戻り値

プロパティの値

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

Condition * Step::GetSubCondition

(

Variant &

val

)

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

引数

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

戻り値

Condition オブジェクト

DataSet * ParameterList::GetTable ( String &  propName )

inherited

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

引数

propName

プロパティ名

戻り値

DataSet （点列）

DataSetList * ParameterList::GetTableList ( String &  propName )

inherited

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

引数

propName

プロパティ名

戻り値

DataSetList （点列リスト）

double ParameterList::GetValue ( String &  propName )

virtualinherited

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

引数

propName

プロパティ名

戻り値

プロパティの値

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

virtualinherited

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

引数

propName	プロパティ名
unitName	単位

戻り値

プロパティの値

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

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

引数

condition	Condition オブジェクト
subIndex	定常判定条件のインデックス

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

非推奨:

インデックスを指定して、定常判定条件を挿入します。

引数

conditionIndex	挿入する条件のインデックス
subIndex	定常判定条件のインデックス

bool Step::IsValid ( )

virtual

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

戻り値

Step オブジェクトの有効・無効

ParameterListを再実装しています。

int Step::NumSubConditions

(

)

定常判定条件の数を整数で取得します。

戻り値

スタディ中の条件の数

void Step::RemoveSubCondition

(

Variant &

val

)

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

戻り値

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

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

virtualinherited

複素数を設定します。

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

引数

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

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

virtualinherited

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

引数

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

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

ステップコントロールと関連付ける回路素子を指定します。

引数

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

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

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

引数

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

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	単位