ResultDefinition クラス

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

ContourDefinition, FluxLineDefinition, VectorDefinitionに継承されています。

公開メンバ関数
void	AddCutPlane (Variant &index)
	設定するカット面を追加します。 [詳解]
void	ClearCutPlanes ()
	カット面設定をクリアします。
String	DigitsNotationTypeName ()
	スケールバーの目盛の数値表記タイプを取得します。 [詳解]
bool	GetAutoScale ()
	自動スケールに設定されている場合、戻り値として True を取得します。 [詳解]
StringList	GetCutPlaneList ()
	カット面設定のインデックスリストを取得します。 [詳解]
bool	GetDisplayScaleBar ()
	スケールバーを表示する時に True を取得します。 [詳解]
String	GetGradientName ()
	グラデーションのタイプ名を、文字列で取得します。 [詳解]
Variant	GetGradientNames ()
	グラデーションのタイプの名称リストを取得します。 [詳解]
int	GetLeftPosition ()
	ユーザが指定したLeft位置の値を取得します。 [詳解]
int	GetLevels ()
	色のレベル数を、整数で取得します。 [詳解]
bool	GetLogScale ()
	スケーリングの種類を取得します。スケーリングが対数目盛の場合、True が取得されます。 [詳解]
double	GetMax ()
	最大値を実数で取得します。 [詳解]
double	GetMin ()
	最小値を実数で取得します。 [詳解]
bool	GetModelCopy ()
	モデルコピー表示設定を取得します。設定されている場合 True が取得されます。 [詳解]
String	GetName ()
	プロットの名称を文字列で取得します。 [詳解]
int	GetNumLabels ()
	スケールバーのラベル数を取得します。 [詳解]
String	GetResultCoordinateName ()
	コンター表示に適用されている座標系の名称を取得します。 [詳解]
String	GetResultCoordinateNameList ()
	コンターに適用可能な座標系の一覧を取得します。 [詳解]
virtual String	GetResultType ()
	結果のタイプの名称を、文字列で取得します。 [詳解]
Variant	GetResultTypeNames ()
	結果のタイプの名称リストを取得します。 [詳解]
Condition *	GetScalingFactor ()
	設定されているスケーリングを取得します。 [詳解]
bool	GetSmooth ()
	スムースに設定されている場合、戻り値として True を取得します。 [詳解]
int	GetTopPosition ()
	ユーザが指定したTop位置の値を取得します。 [詳解]
bool	GetTransparencyNonTarget ()
	対象部品以外に透明度の設定を取得します。設定されている場合 True が取得されます。 [詳解]
int	GetTransparencyValueNonTarget ()
	対象部品以外の透明度を取得します。 [詳解]
bool	GetUseSpecifiedPosition ()
	ユーザが指定した位置にスケールバーを表示したい時に True を取得します。 [詳解]
int	GetViewIndex ()
	設定されている視点のインデックスを取得します。 [詳解]
bool	GetViewOriginalModel ()
	原型図表示設定を取得します。設定されている場合 True が取得されます。 [詳解]
bool	GetViewPoint ()
	視点設定を取得します。設定されている場合Trueが取得されます。 [詳解]
bool	GetViewScale ()
	スケール表示設定を取得します。設定されている場合Trueが取得されます。 [詳解]
bool	IsEditMode ()
	編集モードかどうかを取得します [詳解]
bool	IsValid ()
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
int	Precision ()
	スケールバーの目盛の小数点以下の表示桁数を取得します。 [詳解]
void	SetAutoScale (bool scale)
	自動スケールのフラグを設定します。 [詳解]
void	SetDigitsNotationType (Variant &type)
	スケールバーの目盛の数値表記タイプを設定します。 [詳解]
void	SetDisplayScaleBar (bool displayScaleBar)
	スケールバー表示を設定します。 [詳解]
void	SetEditMode ()
	一括で設定を行う場合の編集モードを設定します。 SetEditMode関数をコール後はUpdate関数をコールするまで結果項目の更新を行いません。
void	SetGradient (String &name, Variant &levels, bool smooth)
	色のグラデーションを設定するための引数を設定します。 [詳解]
void	SetLogScale (bool logscale)
	スケーリングの種類を指定します。値を True に設定すると、スケーリングが対数目盛になります。 [詳解]
void	SetModelCopy (bool on)
	モデルコピー表示を設定します。 [詳解]
void	SetName (String &name)
	プロットの名称を設定します。 [詳解]
void	SetNumLabels (Variant &labels)
	スケールバーのラベル数を設定します。 [詳解]
void	SetPrecision (Variant &precision)
	スケールバーの目盛の小数点以下の表示桁数を設定します。 [詳解]
void	SetRange (Variant &min, Variant &max)
	最小値と最大値の間で、レンジを設定します。 [詳解]
void	SetResultCoordinate (Variant &name)
	コンター表示に適用されている座標系の名称を取得します。 [詳解]
virtual void	SetResultType (String &typeName, String &sourceTitle=String())
	結果のタイプを設定します。 [詳解]
void	SetScaleBarPosition (Variant &leftPos, Variant &topPos)
	スケールバーの位置を設定します。 [詳解]
void	SetScalingFactor (Condition *cond)
	Condition オブジェクトを指定してスケーリングを設定します。 [詳解]
void	SetTransparencyNonTarget (bool on)
	対象部品以外に透明度を設定します。 [詳解]
void	SetTransparencyValueNonTarget (Variant &value)
	対象部品以外の透明度を設定します。 [詳解]
void	SetUseSpecifiedPosition (bool useSpecifiedPosition)
	スケールバーの指定した位置を使用するかどうかを設定します。 [詳解]
void	SetViewIndex (Variant &index)
	視点のインデックスを指定し、視点を設定します。 [詳解]
void	SetViewName (Variant &name)
	視点の名前を指定し、視点を設定します。 [詳解]
void	SetViewOriginalModel (bool on)
	原型図表示を設定します。 [詳解]
void	SetViewPoint (bool on)
	視点を設定します。 [詳解]
void	SetViewScale (bool on)
	スケール表示を設定します。 [詳解]
void	Update ()
	編集モードを解除して更新処理を行います。 編集モード以外にコールするとスクリプトエラー

詳解

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

コンタープロット、ベクトルプロット、フラックスラインなどの設定で、継承クラスとして使用します。

関数詳解

void ResultDefinition::AddCutPlane

(

Variant &

index

)

設定するカット面を追加します。

引数

index

カット面のインデックスまたは名前

String ResultDefinition::DigitsNotationTypeName

(

)

スケールバーの目盛の数値表記タイプを取得します。

戻り値

数値表記タイプ
automatic ： 自動
sientific ： 指数表示
decimal ： 小数点表示

bool ResultDefinition::GetAutoScale

(

)

自動スケールに設定されている場合、戻り値として True を取得します。

戻り値

自動スケールのオン/オフ

StringList ResultDefinition::GetCutPlaneList

(

)

カット面設定のインデックスリストを取得します。

戻り値

インデックスリスト

bool ResultDefinition::GetDisplayScaleBar

(

)

スケールバーを表示する時に True を取得します。

戻り値

スケールバーを表示するかどうか

String ResultDefinition::GetGradientName

(

)

グラデーションのタイプ名を、文字列で取得します。

戻り値

グラデーションのタイプ名

Variant ResultDefinition::GetGradientNames

(

)

グラデーションのタイプの名称リストを取得します。

戻り値

グラデーションのタイプ名リスト

int ResultDefinition::GetLeftPosition

(

)

ユーザが指定したLeft位置の値を取得します。

戻り値

Left位置の値

int ResultDefinition::GetLevels

(

)

色のレベル数を、整数で取得します。

戻り値

色のレベル数

bool ResultDefinition::GetLogScale

(

)

スケーリングの種類を取得します。スケーリングが対数目盛の場合、True が取得されます。

戻り値

対数目盛のオン/オフ

double ResultDefinition::GetMax

(

)

最大値を実数で取得します。

戻り値

最大値

double ResultDefinition::GetMin

(

)

最小値を実数で取得します。

戻り値

最小値

bool ResultDefinition::GetModelCopy

(

)

モデルコピー表示設定を取得します。設定されている場合 True が取得されます。

戻り値

モデルコピー表示のオン/オフ

String ResultDefinition::GetName

(

)

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

戻り値

プロットの名称

int ResultDefinition::GetNumLabels

(

)

スケールバーのラベル数を取得します。

戻り値

スケールバーのラベル数

String ResultDefinition::GetResultCoordinateName

(

)

コンター表示に適用されている座標系の名称を取得します。

戻り値

座標系の名称

String ResultDefinition::GetResultCoordinateNameList

(

)

コンターに適用可能な座標系の一覧を取得します。

戻り値

座標系の名称一覧

String ResultDefinition::GetResultType ( )

virtual

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

戻り値

結果のタイプの名称

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

Variant ResultDefinition::GetResultTypeNames

(

)

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

戻り値

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

Condition * ResultDefinition::GetScalingFactor

(

)

設定されているスケーリングを取得します。

戻り値

Condition オブジェクト

bool ResultDefinition::GetSmooth

(

)

スムースに設定されている場合、戻り値として True を取得します。

戻り値

スムースのオン/オフ

int ResultDefinition::GetTopPosition

(

)

ユーザが指定したTop位置の値を取得します。

戻り値

Top位置の値

bool ResultDefinition::GetTransparencyNonTarget

(

)

対象部品以外に透明度の設定を取得します。設定されている場合 True が取得されます。

戻り値

透明度のオン/オフ

int ResultDefinition::GetTransparencyValueNonTarget

(

)

対象部品以外の透明度を取得します。

戻り値

透明度(0~100)

bool ResultDefinition::GetUseSpecifiedPosition

(

)

ユーザが指定した位置にスケールバーを表示したい時に True を取得します。

戻り値

ユーザが指定した位置にスケールバーを表示するかどうか

int ResultDefinition::GetViewIndex

(

)

設定されている視点のインデックスを取得します。

戻り値

視点のインデックス

bool ResultDefinition::GetViewOriginalModel

(

)

原型図表示設定を取得します。設定されている場合 True が取得されます。

戻り値

原型図表示のオン/オフ

bool ResultDefinition::GetViewPoint

(

)

視点設定を取得します。設定されている場合Trueが取得されます。

戻り値

視点設定のオン/オフ

bool ResultDefinition::GetViewScale

(

)

スケール表示設定を取得します。設定されている場合Trueが取得されます。

戻り値

スケール表示のオン/オフ

bool ResultDefinition::IsEditMode

(

)

編集モードかどうかを取得します

戻り値

編集モードかどうか

bool ResultDefinition::IsValid

(

)

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

戻り値

ResultDefinition オブジェクトの有効/無効

int ResultDefinition::Precision

(

)

スケールバーの目盛の小数点以下の表示桁数を取得します。

戻り値

小数点以下の表示桁数

void ResultDefinition::SetAutoScale

(

bool

scale

)

自動スケールのフラグを設定します。

引数

scale

オン/オフ

void ResultDefinition::SetDigitsNotationType

(

Variant &

type

)

スケールバーの目盛の数値表記タイプを設定します。

引数

type	数値表記タイプ automatic ： 自動 sientific ： 指数表示 decimal ： 小数点表示

void ResultDefinition::SetDisplayScaleBar

(

bool

displayScaleBar

)

スケールバー表示を設定します。

引数

displayScaleBar

スケールバーを表示のオン/オフ

void ResultDefinition::SetGradient	(	String &	name,
		Variant &	levels,
		bool	smooth
	)

色のグラデーションを設定するための引数を設定します。

引数

name	グラデーション PurpleRed：紫-赤 BlueRed：青-赤 GrayScale：グレー CMR：CMR
levels	レベル数
smooth	スムースカラーバンド

void ResultDefinition::SetLogScale

(

bool

logscale

)

スケーリングの種類を指定します。値を True に設定すると、スケーリングが対数目盛になります。

引数

logscale

True=1 : 対数目盛 False=0 : 線形目盛

void ResultDefinition::SetModelCopy

(

bool

on

)

モデルコピー表示を設定します。

引数

on	モデルコピー表示のオン/オフ

void ResultDefinition::SetName

(

String &

name

)

プロットの名称を設定します。

引数

name

プロットの名称

void ResultDefinition::SetNumLabels

(

Variant &

labels

)

スケールバーのラベル数を設定します。

引数

labels

ラベル数

void ResultDefinition::SetPrecision

(

Variant &

precision

)

スケールバーの目盛の小数点以下の表示桁数を設定します。

引数

precision

小数点以下の表示桁数

void ResultDefinition::SetRange	(	Variant &	min,
		Variant &	max
	)

最小値と最大値の間で、レンジを設定します。

引数

min	最小値
max	最大値

void ResultDefinition::SetResultCoordinate

(

Variant &

name

)

コンター表示に適用されている座標系の名称を取得します。

引数

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

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

virtual

結果のタイプを設定します。

引数

typeName	結果タイプ名
sourceTitle	計算ツールを参照する場合は、結果の計算処理（フーリエ変換など）のタイトル

FluxLineDefinition, ContourDefinition, VectorDefinitionで再実装されています。

void ResultDefinition::SetScaleBarPosition	(	Variant &	leftPos,
		Variant &	topPos
	)

スケールバーの位置を設定します。

引数

leftPos	左からの位置
topPos	下からの位置

void ResultDefinition::SetScalingFactor

(

Condition *

cond

)

Condition オブジェクトを指定してスケーリングを設定します。

引数

cond	Condition オブジェクト

void ResultDefinition::SetTransparencyNonTarget

(

bool

on

)

対象部品以外に透明度を設定します。

引数

on

透明度のオン/オフ

void ResultDefinition::SetTransparencyValueNonTarget

(

Variant &

value

)

対象部品以外の透明度を設定します。

引数

value

透明度(0~100)

void ResultDefinition::SetUseSpecifiedPosition

(

bool

useSpecifiedPosition

)

スケールバーの指定した位置を使用するかどうかを設定します。

引数

useSpecifiedPosition

スケールバーをの位置を指定するのオン/オフ

void ResultDefinition::SetViewIndex

(

Variant &

index

)

視点のインデックスを指定し、視点を設定します。

引数

index

視点のインデックス

void ResultDefinition::SetViewName

(

Variant &

name

)

視点の名前を指定し、視点を設定します。

引数

name

視点の名前

void ResultDefinition::SetViewOriginalModel

(

bool

on

)

原型図表示を設定します。

引数

on	原型図表示のオン/オフ

void ResultDefinition::SetViewPoint

(

bool

on

)

視点を設定します。

引数

on

視点のオン/オフ

void ResultDefinition::SetViewScale

(

bool

on

)

スケール表示を設定します。

引数

on	スケール表示のオン/オフ