StudyProperties クラス

StudyProperties クラスは
スタディプロパティの設定に使用します。
このクラスは Study クラスから呼び出すことができます。
. [詳解]

ParameterListを継承しています。

公開メンバ関数
int	GetCoordinateSystemIndex (String &propName)
	プロパティの座標系のインデックスを取得します。 [詳解]
String	GetCoordinateSystemName (String &propName)
	プロパティの座標系の名称を取得します。 [詳解]
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)
	プロパティの値を単位指定で実数で取得します。 [詳解]
bool	IsValid ()
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
virtual void	SetComplexValue (String &propName, double real, double imag)
	複素数を設定します。 [詳解]
void	SetCoordinateSystem (String &propName, Variant &val)
	プロパティに座標系を設定します。 [詳解]
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 &val)
	プロパティに実数値または整数値を設定します。 [詳解]
virtual void	SetValueWithUnit (String &propName, double value, String &unitName)
	実数またはフラグのプロパティの値を単位指定で設定します。 [詳解]

詳解

StudyProperties クラスは
スタディプロパティの設定に使用します。
このクラスは Study クラスから呼び出すことができます。
.

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

app.GetModel(0).GetStudy(0).GetStudyProperties()

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

• "スタディプロパティ（2次元）"
• "スタディプロパティ（3次元）"
• "スタディプロパティ（鉄損解析）"

関数詳解

int StudyProperties::GetCoordinateSystemIndex

(

String &

propName

)

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

引数

propName

プロパティ名

戻り値

座標系のインデックス

String StudyProperties::GetCoordinateSystemName

(

String &

propName

)

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

引数

propName

プロパティ名

戻り値

座標系名

String ParameterList::GetFlagAsString ( String &  name )

virtualinherited

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

引数

name

プロパティ名

戻り値

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

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

virtualinherited

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

引数

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

戻り値

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

Variant ParameterList::GetKeyNames ( String &  name )

inherited

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

引数

name

プロパティ名

戻り値

フラグ一覧

String ParameterList::GetPropertyHelp ( String &  propName )

virtualinherited

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

引数

propName

プロパティ名

戻り値

プロパティのヘルプ

Variant ParameterList::GetPropertyNames ( )

inherited

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

戻り値

条件中のプロパティ名

String ParameterList::GetPropertyTable ( )

inherited

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

戻り値

プロパティの一覧

String ParameterList::GetPropertyType ( String &  propName )

virtualinherited

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

引数

propName

プロパティ名

戻り値

プロパティのタイプ

String StudyProperties::GetStringValue ( String &  propName )

virtual

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

引数

propName

プロパティ名

戻り値

文字列の値

ParameterListを再実装しています。

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

戻り値

プロパティの値

bool StudyProperties::IsValid ( )

virtual

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

戻り値

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

ParameterListを再実装しています。

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

virtualinherited

複素数を設定します。

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

引数

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

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

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

引数

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

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

virtualinherited

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

引数

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

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 StudyProperties::SetValue ( String &  propName, Variant &  val  )

virtual

プロパティに実数値または整数値を設定します。

引数

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

ParameterListを再実装しています。

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

virtualinherited

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

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

引数

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