CircuitComponent クラス

CircuitComponent クラスは
回路の各素子の設定に使用します。
Circuit クラスから呼び出すことができます。
. [詳解]

ParameterListを継承しています。

公開メンバ関数
void	AddInstanceLink (String &propName, String &instanceName)
	発熱素子の参照素子を追加します。 [詳解]
void	ClearInstanceLink (String &propName)
	抵抗素子、スイッチ素子、発熱素子の、参照素子をクリアします。 [詳解]
void	DeleteInstanceLink (String &propName, String &instanceName)
	発熱素子の参照素子を削除します。 [詳解]
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	GetMacroTranslationKey ()
	マクロ素子のキー文字列を取得します [詳解]
String	GetName ()
	素子の名称を文字列で取得します。 [詳解]
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)
	指定したプロパティの点列リストの値を取得します。 [詳解]
String	GetType ()
	素子のタイプを文字列で取得します。 [詳解]
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	SetFunction (FunctionObject *func)
	素子に FunctionObject を設定します。 [詳解]
void	SetInstanceLink (String &propName, String &instanceName)
	抵抗素子、スイッチ素子、発熱素子の参照素子を指定します。 [詳解]
void	SetLink (String &name)
	回路に条件付ける回路素子を設定します。 [詳解]
void	SetName (String &name)
	条件の名称を設定します。 [詳解]
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)
	実数またはフラグのプロパティの値を設定します。値の単位は考慮されずに、現在使用中の単位が使用されます。 [詳解]
void	SetValueWithPassword (String &propName, Variant &value, String &password)
	ファイル名とパスワードを指定します。 [詳解]
virtual void	SetValueWithUnit (String &propName, double value, String &unitName)
	実数またはフラグのプロパティの値を単位指定で設定します。 [詳解]

詳解

CircuitComponent クラスは
回路の各素子の設定に使用します。
Circuit クラスから呼び出すことができます。
.

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

app.GetModel(0).GetStudy(0).GetCircuit().GetComponent(0)

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

関数詳解

void CircuitComponent::AddInstanceLink	(	String &	propName,
		String &	instanceName
	)

発熱素子の参照素子を追加します。

発熱素子の参照タイプで使用します。

引数

propName	発熱素子の参照素子タイプ “reference”=参照タイプの場合の参照素子
instanceName	素子の名称

void CircuitComponent::ClearInstanceLink

(

String &

propName

)

抵抗素子、スイッチ素子、発熱素子の、参照素子をクリアします。

抵抗素子またはスイッチ素子の場合、電流依存性または電圧依存性タイプで使用します。 発熱素子の場合、参照タイプで使用します。

引数

propName	抵抗素子またはスイッチ素子の場合の参照素子タイプ “reference”=電流依存性の場合の参照素子 “terminal1”=電圧依存性の場合の参照第1電位プローブ素子 “terminal2”=電圧依存性の場合の参照第2電位プローブ素子 発熱素子の場合の参照素子タイプ “reference”=参照タイプの場合の参照素子
instanceName	素子の名称

void CircuitComponent::DeleteInstanceLink	(	String &	propName,
		String &	instanceName
	)

発熱素子の参照素子を削除します。

発熱素子の参照タイプで使用します。

引数

propName	発熱素子の参照素子タイプ “reference”=参照タイプの場合の参照素子
instanceName	素子の名称

String ParameterList::GetFlagAsString ( String &  name )

virtualinherited

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

引数

name

プロパティ名

戻り値

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

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

virtualinherited

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

引数

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

戻り値

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

FunctionObject * CircuitComponent::GetFunction

(

)

素子にセットされている FunctionObject を取得します。

たとえば、電流源の関数パラメータを再設定したいときに使います。

戻り値

FunctionObject オブジェクト

String CircuitComponent::GetInstanceLink

(

String &

propName

)

抵抗素子、スイッチ素子、発熱素子の参照素子を取得します。

抵抗素子またはスイッチ素子の場合、電流依存性または電圧依存性タイプで使用します。 発熱素子の場合、参照タイプで使用します。

引数

propName

抵抗素子またはスイッチ素子の場合の参照素子タイプ “reference”=電流依存性の場合の参照素子 “terminal1”=電圧依存性の場合の参照第1電位プローブ素子 “terminal2”=電圧依存性の場合の参照第2電位プローブ素子 発熱素子の場合の参照素子タイプ “reference”=参照タイプの場合の参照素子

戻り値

素子の名称

Variant ParameterList::GetKeyNames ( String &  name )

inherited

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

引数

name

プロパティ名

戻り値

フラグ一覧

String CircuitComponent::GetLink

(

)

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

戻り値

回路素子名

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

String CircuitComponent::GetMacroTranslationKey

(

)

マクロ素子のキー文字列を取得します

戻り値

キー文字列

String CircuitComponent::GetName

(

)

素子の名称を文字列で取得します。

戻り値

素子の名称

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で再実装されています。

DataSet * ParameterList::GetTable ( String &  propName )

inherited

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

引数

propName

プロパティ名

戻り値

DataSet （点列）

DataSetList * ParameterList::GetTableList ( String &  propName )

inherited

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

引数

propName

プロパティ名

戻り値

DataSetList （点列リスト）

String CircuitComponent::GetType

(

)

素子のタイプを文字列で取得します。

戻り値

素子のタイプ名

double ParameterList::GetValue ( String &  propName )

virtualinherited

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

引数

propName

プロパティ名

戻り値

プロパティの値

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

virtualinherited

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

引数

propName	プロパティ名
unitName	単位

戻り値

プロパティの値

bool CircuitComponent::IsValid ( )

virtual

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

戻り値

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

ParameterListを再実装しています。

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

virtualinherited

複素数を設定します。

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

引数

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

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

virtualinherited

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

引数

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

void CircuitComponent::SetFunction

(

FunctionObject *

func

)

素子に FunctionObject を設定します。

素子に関数を設定する時に使います。

引数

func	FunctionObject オブジェクト

void CircuitComponent::SetInstanceLink	(	String &	propName,
		String &	instanceName
	)

抵抗素子、スイッチ素子、発熱素子の参照素子を指定します。

抵抗素子またはスイッチ素子の場合、電流依存性または電圧依存性タイプで使用します。 発熱素子の場合、参照タイプで使用します。

引数

propName	抵抗素子またはスイッチ素子の場合の参照素子タイプ “reference”=電流依存性の場合の参照素子 “terminal1”=電圧依存性の場合の参照第1電位プローブ素子 “terminal2”=電圧依存性の場合の参照第2電位プローブ素子 発熱素子の場合の参照素子タイプ “reference”=参照タイプの場合の参照素子
instanceName	素子の名称

void CircuitComponent::SetLink

(

String &

name

)

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

引数

name

回路素子名

void CircuitComponent::SetName

(

String &

name

)

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

引数

name

条件名

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

virtual

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

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

引数

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

ParameterListを再実装しています。

void CircuitComponent::SetValueWithPassword	(	String &	propName,
		Variant &	value,
		String &	password
	)

ファイル名とパスワードを指定します。

引数

propName	プロパティ名
value	プロパティの値
password	プロパティのパスワード

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

virtualinherited

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

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

引数

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