ParameterList クラス

ParameterList クラスには 各プロパティの設定において共通となるメンバが定義されています。
. [詳解]

CircuitComponent, Condition, MaterialObject, Step, StudyPropertiesに継承されています。

公開メンバ関数
virtual String	GetFlagAsString (String &name)
	指定したプロパティの設定を、フラグプロパティ名で取得します。 [詳解]
virtual String	GetFlagPropertyHelp (String &propName, Variant &val)
	名称またはインデックスを指定して、フラグプロパティのヘルプを文字列として取得します。 [詳解]
Variant	GetKeyNames (String &name)
	指定したプロパティで設定可能なフラグの一覧を取得します。 [詳解]
virtual String	GetPropertyHelp (String &propName)
	プロパティのヘルプを文字列として取得します。 [詳解]
Variant	GetPropertyNames ()
	条件中で設定可能な全プロパティの名称リストを取得します。 [詳解]
String	GetPropertyTable ()
	タイプ、ヘルプを含むプロパティの一覧を取得します。 [詳解]
virtual String	GetPropertyType (String &propName)
	プロパティの型を取得します。 [詳解]
virtual String	GetStringValue (String &propName)
	プロパティの値を文字列で取得します。 [詳解]
DataSet *	GetTable (String &propName)
	指定したプロパティの点列を取得します。 [詳解]
DataSetList *	GetTableList (String &propName)
	指定したプロパティの点列リストの値を取得します。 [詳解]
virtual double	GetValue (String &propName)
	プロパティの値を実数で取得します。 [詳解]
virtual double	GetValueWithUnit (String &propName, String &unitName)
	プロパティの値を単位指定で実数で取得します。 [詳解]
virtual bool	IsValid ()
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
virtual void	SetComplexValue (String &propName, double real, double imag)
	複素数を設定します。 [詳解]
virtual void	SetFlagByName (String &propName, String &scriptKeyName)
	名称を指定して、フラグプロパティの値を設定します。 [詳解]
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)
	実数またはフラグのプロパティの値を単位指定で設定します。 [詳解]

詳解

ParameterList クラスには 各プロパティの設定において共通となるメンバが定義されています。
.

回路素子、条件、材料、スタディプロパティなどの設定で、継承クラスとして使用します。
各項に付随するプロパティの指定には、引数として使用するプロパティ名およびフラグ に掲載するプロパティ名およびフラグを使用します。

関数詳解

String ParameterList::GetFlagAsString ( String &  name )

virtual

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

引数

name

プロパティ名

戻り値

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

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

virtual

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

引数

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

戻り値

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

Variant ParameterList::GetKeyNames

(

String &

name

)

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

引数

name

プロパティ名

戻り値

フラグ一覧

String ParameterList::GetPropertyHelp ( String &  propName )

virtual

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

引数

propName

プロパティ名

戻り値

プロパティのヘルプ

Variant ParameterList::GetPropertyNames

(

)

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

戻り値

条件中のプロパティ名

String ParameterList::GetPropertyTable

(

)

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

戻り値

プロパティの一覧

String ParameterList::GetPropertyType ( String &  propName )

virtual

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

引数

propName

プロパティ名

戻り値

プロパティのタイプ

String ParameterList::GetStringValue ( String &  propName )

virtual

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

引数

propName

プロパティ名

戻り値

プロパティの値

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

DataSet * ParameterList::GetTable

(

String &

propName

)

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

引数

propName

プロパティ名

戻り値

DataSet （点列）

DataSetList * ParameterList::GetTableList

(

String &

propName

)

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

引数

propName

プロパティ名

戻り値

DataSetList （点列リスト）

double ParameterList::GetValue ( String &  propName )

virtual

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

引数

propName

プロパティ名

戻り値

プロパティの値

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

virtual

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

引数

propName	プロパティ名
unitName	単位

戻り値

プロパティの値

bool ParameterList::IsValid ( )

virtual

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

戻り値

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

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

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

virtual

複素数を設定します。

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

引数

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

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

virtual

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

引数

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

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

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

引数

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

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

点列ファイル（*.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
	)

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

引数

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

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

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

引数

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

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

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

引数

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

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

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

引数

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

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

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

引数

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

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

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

引数

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

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

virtual

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

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

引数

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

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

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

virtual

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

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

引数

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