ProbeDefinition クラス

ProbeDefinition クラスは モデル上の任意の位置の結果を確認するプローブに使用します。
Study クラスから呼び出すことができます。
. [詳解]

公開メンバ関数
void	AddId (int id, String &name)
	ID指定の測定位置を追加します。 [詳解]
void	AddLocation (Variant &x, Variant &y, Variant &z, String &name)
	座標指定の測定位置を追加します。 [詳解]
void	AddPoint (Point *position, String &name)
	座標指定の測定位置を追加します。 [詳解]
void	AddPointWithUnit (Point *position, String &unitName, String &name)
	座標指定の測定位置を単位指定で追加します。 [詳解]
void	Build ()
	データ更新を実行します。
void	ClearPoints ()
	すべての測定位置を削除します。
void	ExportPoints (String &filename)
	測定位置のCSVファイルに書き出します。 [詳解]
bool	GetAutoRecalculate ()
	自動でデータ更新を行うか否かのフラグを取得します。 [詳解]
DataSet *	GetCaseDataSet (int caseno)
	指定されたケースの DataSet オブジェクトを取得します。 [詳解]
String	GetComponent ()
	成分の名称を文字列で取得します。 [詳解]
Variant	GetComponentNames ()
	成分の名称リストを取得します。 [詳解]
DataSet *	GetDataSet ()
	DataSet オブジェクトを取得します。 [詳解]
String	GetLocationCoordinateName ()
	測定位置に適用されている評価座標系の名称を取得します。 [詳解]
bool	GetMoveWithPart ()
	プローブが測定対象とともに移動する場合、戻り値としてTrueを取得します。 [詳解]
String	GetName ()
	プローブの名称を文字列で取得します。 [詳解]
double	GetPhase ()
	位相を取得します。 [詳解]
String	GetPhaseType ()
	表示タイプを取得します。 [詳解]
Point *	GetPoint (int index)
	インデックスで指定された測定位置の座標を取得します。 [詳解]
String	GetPointName (int index)
	インデックスで指定された測定位置の名称を取得します。 [詳解]
Point *	GetPointWithUnit (int index, String &unitName)
	インデックスで指定された測定位置の座標を単位指定で取得します。 [詳解]
int	GetPositionId (int index)
	測定位置のインデックスを指定して、要素IDもしくは節点IDを取得します。 [詳解]
String	GetProbeType ()
	プローブの各測定位置の指定方法の種類を文字列で取得します。 [詳解]
StringList	GetProbeTypeNames ()
	各プローブの測定位置の指定方法をリストを取得します。 [詳解]
int	GetReferenceStep ()
	参照ステップを取得します。 [詳解]
String	GetResultCoordinateName ()
	プローブに適用されている参照座標系の名称を取得します。 [詳解]
String	GetResultCoordinateNameList ()
	プローブに適用可能な座標系の一覧を取得します。 [詳解]
String	GetResultType ()
	結果のタイプの名称を文字列で取得します。 [詳解]
Variant	GetResultTypeNames ()
	結果のタイプの名称リストを取得します。 [詳解]
double	GetTemperature ()
	温度を取得します。 [詳解]
bool	GetUseElementValue ()
	要素の値を使用する場合、戻り値としてTrueを取得します。 [詳解]
String	GetUserComponentType ()
	ユーザーコンポーネントの名称を文字列で取得します。 [詳解]
void	ImportPoints (String &filename)
	測定位置をCSVファイルから読み込みます。 [詳解]
bool	IsValid ()
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
int	NumPoints ()
	測定位置の数を取得します。 [詳解]
void	RemovePoint (int index)
	インデックスで指定された測定位置を削除します。 [詳解]
void	RenamePoint (int index, String &name)
	インデックスで指定された測定位置の名称を変更します。 [詳解]
void	SetAutoRecalculate (bool flag)
	定義の更新時に自動でデータ更新を行うか否かを設定します。 [詳解]
void	SetComponent (String &name)
	結果の成分を設定します。 [詳解]
void	SetHistoryAllSteps ()
	ヒストリ関数の参照範囲をすべてのステップに設定します。
void	SetHistorySteps (String array &steps)
	ヒストリ関数の参照範囲となるステップを指定します。 [詳解]
void	SetHistoryStepsByString (String &str)
	ヒストリ関数の参照範囲となるステップを文字列によって指定します。 [詳解]
void	SetId (int index, int id)
	測定位置のインデックスを指定して、要素IDまたは節点のIDを指定します。 [詳解]
void	SetLocation (int index, Variant &x, Variant &y, Variant &z)
	座標指定の測定位置を設定します。 [詳解]
void	SetLocationCoordinate (Variant &name)
	名称またはインデックスを指定して、測定位置に評価座標系を適用します。 [詳解]
void	SetMoveWithPart (bool value)
	プローブを測定対象とともに移動するフラグを設定します。 [詳解]
void	SetName (String &name)
	プローブの名称を設定します。 [詳解]
void	SetPhase (double value)
	位相を設定します。 [詳解]
void	SetPhaseType (Variant &value)
	表示タイプを指定します。 [詳解]
void	SetPoint (int index, Point *position)
	座標指定の測定位置を追加します。 [詳解]
void	SetPointWithUnit (int index, Point *position, String &unitName)
	座標指定の測定位置を単位指定で追加します。 [詳解]
void	SetProbeType (Variant &name)
	プローブの各測定位置の指定方法の種類を指定します。 [詳解]
void	SetReferenceStep (Variant &step)
	参照ステップを設定します。 [詳解]
void	SetResultCoordinate (Variant &name)
	名称またはインデックスを指定して、プローブに参照座標系を適用します。 [詳解]
void	SetResultType (String &ytpeName, String &sourceTitle=String())
	名称によって、結果のタイプを設定します。 [詳解]
void	SetTemperature (Variant &value)
	温度を設定します。 [詳解]
void	SetUseElementValue (bool use)
	要素の値を使用するフラグを設定します。 [詳解]
void	SetUserComponentType (String &name)
	ユーザーコンポーネントを設定します。 [詳解]

詳解

ProbeDefinition クラスは モデル上の任意の位置の結果を確認するプローブに使用します。
Study クラスから呼び出すことができます。
.

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

app.GetModel(0).GetStudy(0).GetProbe(0)

• 参照座標系は、結果の成分に適用される座標系です。
  
• 評価座標系は、測定位置の座標に適用される座標系です。
  

関数詳解

void ProbeDefinition::AddId	(	int	id,
		String &	name
	)

ID指定の測定位置を追加します。

引数

id	要素ID または 節点ID
name	測定位置の名称

void ProbeDefinition::AddLocation	(	Variant &	x,
		Variant &	y,
		Variant &	z,
		String &	name
	)

座標指定の測定位置を追加します。

引数

x	X座標
y	Y座標
z	Z座標
name	測定位置の名称

void ProbeDefinition::AddPoint	(	Point *	position,
		String &	name
	)

座標指定の測定位置を追加します。

引数

position	Point オブジェクト（測定位置の座標）
name	測定位置の名称

void ProbeDefinition::AddPointWithUnit	(	Point *	position,
		String &	unitName,
		String &	name
	)

座標指定の測定位置を単位指定で追加します。

引数

position	Point オブジェクト（測定位置の座標）
unitName	単位
name	測定位置の名称

void ProbeDefinition::ExportPoints

(

String &

filename

)

測定位置のCSVファイルに書き出します。

引数

filename

エクスポートするファイルのパス

bool ProbeDefinition::GetAutoRecalculate

(

)

自動でデータ更新を行うか否かのフラグを取得します。

戻り値

自動データ更新のオン/オフ

DataSet * ProbeDefinition::GetCaseDataSet

(

int

caseno

)

指定されたケースの DataSet オブジェクトを取得します。

引数

caseno

ケース番号

戻り値

DataSet オブジェクト

caseno は、1から始まる番号です。

String ProbeDefinition::GetComponent

(

)

成分の名称を文字列で取得します。

戻り値

成分の名称

Variant ProbeDefinition::GetComponentNames

(

)

成分の名称リストを取得します。

戻り値

成分の名称リスト

DataSet * ProbeDefinition::GetDataSet

(

)

DataSet オブジェクトを取得します。

戻り値

DataSet オブジェクト

String ProbeDefinition::GetLocationCoordinateName

(

)

測定位置に適用されている評価座標系の名称を取得します。

戻り値

評価座標系の名称

bool ProbeDefinition::GetMoveWithPart

(

)

プローブが測定対象とともに移動する場合、戻り値としてTrueを取得します。

戻り値

測定対象とともに移動するか否か

String ProbeDefinition::GetName

(

)

プローブの名称を文字列で取得します。

戻り値

プローブの名称

double ProbeDefinition::GetPhase

(

)

位相を取得します。

磁界周波数応答解析、構造固有モード解析、構造周波数応答解析、電界周波数応答解析の一部の出力項目で取得可能です。

戻り値

位相

String ProbeDefinition::GetPhaseType

(

)

表示タイプを取得します。

磁界周波数応答解析、構造固有モード解析、構造周波数応答解析、電界周波数応答解析の一部の出力項目で取得可能です。

戻り値

表示タイプ

"RealImag" = 実部と虚部を表示
"AmplitudePhase" = 振幅と位相を表示
"FixedPhase" = 位相指定 

Point * ProbeDefinition::GetPoint

(

int

index

)

インデックスで指定された測定位置の座標を取得します。

引数

index

測定位置のインデックス（0から開始）

戻り値

Point オブジェクト

String ProbeDefinition::GetPointName

(

int

index

)

インデックスで指定された測定位置の名称を取得します。

引数

index

測定位置のインデックス（0から開始）

戻り値

測定位置の名称

Point * ProbeDefinition::GetPointWithUnit	(	int	index,
		String &	unitName
	)

インデックスで指定された測定位置の座標を単位指定で取得します。

引数

index	測定位置のインデックス（0から開始）
unitName	単位

戻り値

Point オブジェクト

int ProbeDefinition::GetPositionId

(

int

index

)

測定位置のインデックスを指定して、要素IDもしくは節点IDを取得します。

引数

index

測定位置のインデックス（0から開始）

戻り値

要素ID または 節点ID

String ProbeDefinition::GetProbeType

(

)

プローブの各測定位置の指定方法の種類を文字列で取得します。

戻り値

"Coordinate" = 座標指定
"Id" = ID指定

StringList ProbeDefinition::GetProbeTypeNames

(

)

各プローブの測定位置の指定方法をリストを取得します。

戻り値

プローブのタイプの名称リスト

int ProbeDefinition::GetReferenceStep

(

)

参照ステップを取得します。

戻り値

参照ステップ番号

このコマンドは、磁界解析の減磁率(参照ステップとの差分)を選択している場合に使用します。

String ProbeDefinition::GetResultCoordinateName

(

)

プローブに適用されている参照座標系の名称を取得します。

戻り値

参照座標系の名称

String ProbeDefinition::GetResultCoordinateNameList

(

)

プローブに適用可能な座標系の一覧を取得します。

戻り値

座標系の名称一覧

String ProbeDefinition::GetResultType

(

)

結果のタイプの名称を文字列で取得します。

戻り値

結果のタイプの名称

Variant ProbeDefinition::GetResultTypeNames

(

)

結果のタイプの名称リストを取得します。

戻り値

結果のタイプの名称リスト

double ProbeDefinition::GetTemperature

(

)

温度を取得します。

戻り値

温度

このコマンドは、磁界解析の減磁率(未減磁状態との差分・温度指定あり)を選択している場合に使用します。

bool ProbeDefinition::GetUseElementValue

(

)

要素の値を使用する場合、戻り値としてTrueを取得します。

戻り値

要素の値の使用のオン/オフ

String ProbeDefinition::GetUserComponentType

(

)

ユーザーコンポーネントの名称を文字列で取得します。

戻り値

ユーザーコンポーネントの名称

void ProbeDefinition::ImportPoints

(

String &

filename

)

測定位置をCSVファイルから読み込みます。

引数

filename

インポートするファイルのパス

bool ProbeDefinition::IsValid

(

)

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

戻り値

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

int ProbeDefinition::NumPoints

(

)

測定位置の数を取得します。

戻り値

測定位置の数

void ProbeDefinition::RemovePoint

(

int

index

)

インデックスで指定された測定位置を削除します。

引数

index

測定位置のインデックス（0から開始）

void ProbeDefinition::RenamePoint	(	int	index,
		String &	name
	)

インデックスで指定された測定位置の名称を変更します。

引数

index	測定位置のインデックス（0から開始）
name	測定位置の名称

void ProbeDefinition::SetAutoRecalculate

(

bool

flag

)

定義の更新時に自動でデータ更新を行うか否かを設定します。

引数

flag	True=1 : 自動でデータ更新を行う False=0 : 自動でデータ更新を行わない

void ProbeDefinition::SetComponent

(

String &

name

)

結果の成分を設定します。

引数

name

成分の名称

void ProbeDefinition::SetHistorySteps

(

String array &

steps

)

ヒストリ関数の参照範囲となるステップを指定します。

引数

steps

ステップ番号

void ProbeDefinition::SetHistoryStepsByString

(

String &

str

)

ヒストリ関数の参照範囲となるステップを文字列によって指定します。

ステップは「1,2,3」のようにカンマで区切って指定するか、「4-8」のように範囲を指定することが可能です。

引数

str

ステップ

void ProbeDefinition::SetId	(	int	index,
		int	id
	)

測定位置のインデックスを指定して、要素IDまたは節点のIDを指定します。

引数

index	測定位置のインデックス（0から開始）
id	要素ID または 節点ID

void ProbeDefinition::SetLocation	(	int	index,
		Variant &	x,
		Variant &	y,
		Variant &	z
	)

座標指定の測定位置を設定します。

引数

index	測定位置のインデックス
x	X座標
y	Y座標
z	Z座標

void ProbeDefinition::SetLocationCoordinate

(

Variant &

name

)

名称またはインデックスを指定して、測定位置に評価座標系を適用します。

引数

name	座標系の名称またはインデックス

void ProbeDefinition::SetMoveWithPart

(

bool

value

)

プローブを測定対象とともに移動するフラグを設定します。

引数

value

True=1 : 測定対象とともに移動する False=0 : 測定対象とともに移動しない

void ProbeDefinition::SetName

(

String &

name

)

プローブの名称を設定します。

引数

name

プローブの名称

void ProbeDefinition::SetPhase

(

double

value

)

位相を設定します。

磁界周波数応答解析、構造固有モード解析、構造周波数応答解析、電界周波数応答解析の一部の出力項目で取得可能です。

引数

value

位相

void ProbeDefinition::SetPhaseType

(

Variant &

value

)

表示タイプを指定します。

磁界周波数応答解析、構造固有モード解析、構造周波数応答解析、電界周波数応答解析の一部の出力項目で取得可能です。

引数

value

表示タイプ 位相タイプ "RealImag" or "0" = 実部と虚部を表示 "AmplitudePhase" or "1" = 振幅と位相を表示 "FixedPhase" or "2" = 位相指定

void ProbeDefinition::SetPoint	(	int	index,
		Point *	position
	)

座標指定の測定位置を追加します。

引数

index	測定位置のインデックス
position	Point オブジェクト（測定位置の座標）

void ProbeDefinition::SetPointWithUnit	(	int	index,
		Point *	position,
		String &	unitName
	)

座標指定の測定位置を単位指定で追加します。

引数

index	測定位置のインデックス
position	Point オブジェクト（測定位置の座標）
unitName	単位

void ProbeDefinition::SetProbeType

(

Variant &

name

)

プローブの各測定位置の指定方法の種類を指定します。

引数

name	"Coordinate" または 0 : 座標指定 "Id" または 1 : ID指定

void ProbeDefinition::SetReferenceStep

(

Variant &

step

)

参照ステップを設定します。

引数

step

参照ステップ番号

このコマンドは、結果のタイプとして減磁率(参照ステップとの差分)を表示する際に設定します。

void ProbeDefinition::SetResultCoordinate

(

Variant &

name

)

名称またはインデックスを指定して、プローブに参照座標系を適用します。

引数

name	座標系の名称またはインデックス

void ProbeDefinition::SetResultType	(	String &	typeName,
		String &	sourceTitle = String()
	)

名称によって、結果のタイプを設定します。

引数

typeName	結果タイプ名
sourceTitle	FFT計算などのタイトル

sourceTitleは省略できます。

typeName として指定可能な条件タイプ名については、物理量の表示状態を変更するもの を参照してください。

void ProbeDefinition::SetTemperature

(

Variant &

value

)

温度を設定します。

引数

value

温度

このコマンドは、結果のタイプとして減磁率(未減磁状態との差分・温度指定あり)を表示する際に設定します。

void ProbeDefinition::SetUseElementValue

(

bool

use

)

要素の値を使用するフラグを設定します。

引数

use	True=1 : 要素の値を使用する False=0 : 要素の値を使用しない

void ProbeDefinition::SetUserComponentType

(

String &

name

)

ユーザーコンポーネントを設定します。

引数

name	ユーザーコンポーネントの名称