ContourDefinition クラス

ContourDefinition クラスは コンタープロットの設定に使用します。
Study クラスから呼び出すことができます。
. [詳解]

ResultDefinitionを継承しています。

公開メンバ関数
void	AddCutPlane (Variant &index)
	設定するカット面を追加します。 [詳解]
void	AddPart (int partId)
	コンターの描画対象のリストに、新たな部品を追加します。 [詳解]
void	ClearCutPlanes ()
	カット面設定をクリアします。
String	DigitsNotationTypeName ()
	スケールバーの目盛の数値表記タイプを取得します。 [詳解]
bool	GetAutoScale ()
	自動スケールに設定されている場合、戻り値として True を取得します。 [詳解]
String	GetComponent ()
	成分の名称を、文字列で取得します。 [詳解]
Variant	GetComponentNames ()
	成分の名称リストを取得します。 [詳解]
String	GetContourType ()
	コンターの表示タイプを、文字列で取得します。 [詳解]
StringList	GetCutPlaneList ()
	カット面設定のインデックスリストを取得します。 [詳解]
bool	GetDisplayAllParts ()
	全ての部品を描画対象とするか否かを取得します。 [詳解]
bool	GetDisplayScaleBar ()
	スケールバーを表示する時に True を取得します。 [詳解]
bool	GetDisplayShellBeam ()
	シェル・ビームの表示・非表示を取得します。 [詳解]
bool	GetDivideElements ()
	四角形の面を細分割するか否かを取得します。 [詳解]
String	GetGradientName ()
	グラデーションのタイプ名を、文字列で取得します。 [詳解]
Variant	GetGradientNames ()
	グラデーションのタイプの名称リストを取得します。 [詳解]
bool	GetIsolines ()
	等値線が選択されている場合、戻り値として True を取得します。 [詳解]
int	GetLeftPosition ()
	ユーザが指定したLeft位置の値を取得します。 [詳解]
int	GetLevels ()
	色のレベル数を、整数で取得します。 [詳解]
bool	GetLogScale ()
	スケーリングの種類を取得します。スケーリングが対数目盛の場合、True が取得されます。 [詳解]
double	GetMax ()
	最大値を実数で取得します。 [詳解]
double	GetMin ()
	最小値を実数で取得します。 [詳解]
bool	GetModelCopy ()
	モデルコピー表示設定を取得します。設定されている場合 True が取得されます。 [詳解]
String	GetName ()
	プロットの名称を文字列で取得します。 [詳解]
int	GetNumLabels ()
	スケールバーのラベル数を取得します。 [詳解]
int	GetReferenceStep ()
	参照ステップ番号を取得します。これはパーミアンスの計算に使用されます。 [詳解]
String	GetResultCoordinateName ()
	コンター表示に適用されている座標系の名称を取得します。 [詳解]
String	GetResultCoordinateNameList ()
	コンターに適用可能な座標系の一覧を取得します。 [詳解]
virtual String	GetResultType ()
	結果のタイプの名称を、文字列で取得します。 [詳解]
Variant	GetResultTypeNames ()
	結果のタイプの名称リストを取得します。 [詳解]
String	GetResultUnit ()
	結果の単位を取得します。 [詳解]
bool	GetScaleByParts ()
	スケーリングを表示モデルの最大/最小値から決めるかどうかのフラグを取得します。 [詳解]
Condition *	GetScalingFactor ()
	設定されているスケーリングを取得します。 [詳解]
bool	GetSmooth ()
	スムースに設定されている場合、戻り値として True を取得します。 [詳解]
double	GetTemperature ()
	温度を取得します。 [詳解]
int	GetTopPosition ()
	ユーザが指定したTop位置の値を取得します。 [詳解]
bool	GetTransparencyNonTarget ()
	対象部品以外に透明度の設定を取得します。設定されている場合 True が取得されます。 [詳解]
int	GetTransparencyValueNonTarget ()
	対象部品以外の透明度を取得します。 [詳解]
String	GetUserComponentType ()
	ユーザーコンポーネントの名称を文字列で取得します。 [詳解]
bool	GetUseSpecifiedPosition ()
	ユーザが指定した位置にスケールバーを表示したい時に True を取得します。 [詳解]
int	GetViewIndex ()
	設定されている視点のインデックスを取得します。 [詳解]
bool	GetViewOriginalModel ()
	原型図表示設定を取得します。設定されている場合 True が取得されます。 [詳解]
bool	GetViewPoint ()
	視点設定を取得します。設定されている場合Trueが取得されます。 [詳解]
bool	GetViewScale ()
	スケール表示設定を取得します。設定されている場合Trueが取得されます。 [詳解]
bool	IsEditMode ()
	編集モードかどうかを取得します [詳解]
bool	IsValid ()
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
int	Precision ()
	スケールバーの目盛の小数点以下の表示桁数を取得します。 [詳解]
void	RemoveAllParts ()
	コンターの描画対象のリストから、全ての部品を削除します。
void	SetAutoScale (bool scale)
	自動スケールのフラグを設定します。 [詳解]
void	SetComponent (String &name)
	結果の成分を設定します。 [詳解]
void	SetContourType (Variant &val)
	コンターの表示タイプ（シェーディング、等値線、要素）を切り替えます。 [詳解]
void	SetDigitsNotationType (Variant &type)
	スケールバーの目盛の数値表記タイプを設定します。 [詳解]
void	SetDisplayAllParts (bool use)
	全ての部品を描画の対象とするか否かを指定します。 [詳解]
void	SetDisplayScaleBar (bool displayScaleBar)
	スケールバー表示を設定します。 [詳解]
void	SetDisplayShellBeam (bool isChecked)
	シェル・ビームの表示・非表示を設定します。 [詳解]
void	SetDivideElements (bool divideElements)
	四角形の面を細分割するか否かを指定します。 [詳解]
void	SetEditMode ()
	一括で設定を行う場合の編集モードを設定します。 SetEditMode関数をコール後はUpdate関数をコールするまで結果項目の更新を行いません。
void	SetGradient (String &name, Variant &levels, bool smooth)
	色のグラデーションを設定するための引数を設定します。 [詳解]
void	SetHistoryAllSteps ()
	すべてのステップをヒストリ関数の参照範囲に含めます。
void	SetHistorySteps (String array &steps)
	ヒストリ関数の参照範囲とするステップを指定します。 [詳解]
void	SetHistoryStepsByString (String &str)
	ヒストリ関数の参照範囲となるステップを文字列によって複数指定します。 [詳解]
void	SetIsolines (bool isoline)
	等値線のフラグを設定します。 [詳解]
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	SetReferenceStep (Variant &step)
	参照ステップ番号を指定します。これはパーミアンスの計算に使用されます。 [詳解]
void	SetResultCoordinate (Variant &name)
	コンター表示に適用されている座標系の名称を取得します。 [詳解]
virtual void	SetResultType (String &typeName, String &sourceTitle=String())
	結果のタイプを設定します。 [詳解]
void	SetResultUnit (String &name)
	結果の単位を設定します。 [詳解]
void	SetScaleBarPosition (Variant &leftPos, Variant &topPos)
	スケールバーの位置を設定します。 [詳解]
void	SetScaleByParts (bool scaleByParts)
	スケーリングを表示モデルの最大/最小値から決めるかどうかを指定します。 [詳解]
void	SetScalingFactor (Condition *cond)
	Condition オブジェクトを指定してスケーリングを設定します。 [詳解]
void	SetTemperature (Variant &value)
	温度を設定します。 [詳解]
void	SetTransparencyNonTarget (bool on)
	対象部品以外に透明度を設定します。 [詳解]
void	SetTransparencyValueNonTarget (Variant &value)
	対象部品以外の透明度を設定します。 [詳解]
void	SetUserComponentType (String &name)
	ユーザーコンポーネントを設定します。 [詳解]
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 ()
	編集モードを解除して更新処理を行います。 編集モード以外にコールするとスクリプトエラー

詳解

ContourDefinition クラスは コンタープロットの設定に使用します。
Study クラスから呼び出すことができます。
.

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

app.GetModel(0).GetStudy(0).GetContour(0)

関数詳解

void ResultDefinition::AddCutPlane ( Variant &  index )

inherited

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

引数

index

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

void ContourDefinition::AddPart

(

int

partId

)

コンターの描画対象のリストに、新たな部品を追加します。

引数

partId

部品のID

String ResultDefinition::DigitsNotationTypeName ( )

inherited

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

戻り値

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

bool ResultDefinition::GetAutoScale ( )

inherited

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

戻り値

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

String ContourDefinition::GetComponent

(

)

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

戻り値

成分の名称

Variant ContourDefinition::GetComponentNames

(

)

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

戻り値

コンポーネントの名称リスト

String ContourDefinition::GetContourType

(

)

コンターの表示タイプを、文字列で取得します。

戻り値

コンターの表示タイプ
Shading : シェーディング
Isoline : 等値線
Element : 要素

StringList ResultDefinition::GetCutPlaneList ( )

inherited

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

戻り値

インデックスリスト

bool ContourDefinition::GetDisplayAllParts

(

)

全ての部品を描画対象とするか否かを取得します。

戻り値

全ての部品を描画対象とするか否か

bool ResultDefinition::GetDisplayScaleBar ( )

inherited

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

戻り値

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

bool ContourDefinition::GetDisplayShellBeam

(

)

シェル・ビームの表示・非表示を取得します。

戻り値

シェル・ビームの表示・非表示

bool ContourDefinition::GetDivideElements

(

)

四角形の面を細分割するか否かを取得します。

戻り値

四角形の面を細分割するか否か

String ResultDefinition::GetGradientName ( )

inherited

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

戻り値

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

Variant ResultDefinition::GetGradientNames ( )

inherited

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

戻り値

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

bool ContourDefinition::GetIsolines

(

)

等値線が選択されている場合、戻り値として True を取得します。

戻り値

等値線のオン/オフ

int ResultDefinition::GetLeftPosition ( )

inherited

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

戻り値

Left位置の値

int ResultDefinition::GetLevels ( )

inherited

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

戻り値

色のレベル数

bool ResultDefinition::GetLogScale ( )

inherited

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

戻り値

対数目盛のオン/オフ

double ResultDefinition::GetMax ( )

inherited

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

戻り値

最大値

double ResultDefinition::GetMin ( )

inherited

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

戻り値

最小値

bool ResultDefinition::GetModelCopy ( )

inherited

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

戻り値

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

String ResultDefinition::GetName ( )

inherited

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

戻り値

プロットの名称

int ResultDefinition::GetNumLabels ( )

inherited

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

戻り値

スケールバーのラベル数

int ContourDefinition::GetReferenceStep

(

)

参照ステップ番号を取得します。これはパーミアンスの計算に使用されます。

戻り値

ステップ番号

String ResultDefinition::GetResultCoordinateName ( )

inherited

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

戻り値

座標系の名称

String ResultDefinition::GetResultCoordinateNameList ( )

inherited

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

戻り値

座標系の名称一覧

String ResultDefinition::GetResultType ( )

virtualinherited

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

戻り値

結果のタイプの名称

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

Variant ResultDefinition::GetResultTypeNames ( )

inherited

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

戻り値

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

String ContourDefinition::GetResultUnit

(

)

結果の単位を取得します。

戻り値

結果の単位

bool ContourDefinition::GetScaleByParts

(

)

スケーリングを表示モデルの最大/最小値から決めるかどうかのフラグを取得します。

戻り値

表示モデルから最大/最小値を決定のオン・オフ

Condition * ResultDefinition::GetScalingFactor ( )

inherited

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

戻り値

Condition オブジェクト

bool ResultDefinition::GetSmooth ( )

inherited

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

戻り値

スムースのオン/オフ

double ContourDefinition::GetTemperature

(

)

温度を取得します。

戻り値

温度

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

int ResultDefinition::GetTopPosition ( )

inherited

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

戻り値

Top位置の値

bool ResultDefinition::GetTransparencyNonTarget ( )

inherited

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

戻り値

透明度のオン/オフ

int ResultDefinition::GetTransparencyValueNonTarget ( )

inherited

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

戻り値

透明度(0~100)

String ContourDefinition::GetUserComponentType

(

)

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

戻り値

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

bool ResultDefinition::GetUseSpecifiedPosition ( )

inherited

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

戻り値

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

int ResultDefinition::GetViewIndex ( )

inherited

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

戻り値

視点のインデックス

bool ResultDefinition::GetViewOriginalModel ( )

inherited

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

戻り値

原型図表示のオン/オフ

bool ResultDefinition::GetViewPoint ( )

inherited

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

戻り値

視点設定のオン/オフ

bool ResultDefinition::GetViewScale ( )

inherited

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

戻り値

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

bool ResultDefinition::IsEditMode ( )

inherited

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

戻り値

編集モードかどうか

bool ResultDefinition::IsValid ( )

inherited

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

戻り値

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

int ResultDefinition::Precision ( )

inherited

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

戻り値

小数点以下の表示桁数

void ResultDefinition::SetAutoScale ( bool  scale )

inherited

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

引数

scale

オン/オフ

void ContourDefinition::SetComponent

(

String &

name

)

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

引数

name

成分の名称

void ContourDefinition::SetContourType

(

Variant &

val

)

コンターの表示タイプ（シェーディング、等値線、要素）を切り替えます。

引数

val	表示タイプ Shading : シェーディング Isoline : 等値線 Element : 要素

void ResultDefinition::SetDigitsNotationType ( Variant &  type )

inherited

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

引数

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

void ContourDefinition::SetDisplayAllParts

(

bool

use

)

全ての部品を描画の対象とするか否かを指定します。

引数

use	True=1 : ［全ての部品を対象とする］を有効にする False=0 : ［全ての部品を対象とする］を無効にする

void ResultDefinition::SetDisplayScaleBar ( bool  displayScaleBar )

inherited

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

引数

displayScaleBar

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

void ContourDefinition::SetDisplayShellBeam

(

bool

isChecked

)

シェル・ビームの表示・非表示を設定します。

引数

isChecked

True=1 : ［シェル・ビームを自動表示する］を有効にする False=0 : ［シェル・ビームを自動表示する］を無効にする

void ContourDefinition::SetDivideElements

(

bool

divideElements

)

四角形の面を細分割するか否かを指定します。

引数

divideElements

True=1 : 細分割する False=0 : 細分割しない

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

inherited

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

引数

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

void ContourDefinition::SetHistorySteps

(

String array &

steps

)

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

引数

steps

ステップ

void ContourDefinition::SetHistoryStepsByString

(

String &

str

)

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

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

引数

str

ステップ

void ContourDefinition::SetIsolines

(

bool

isoline

)

等値線のフラグを設定します。

引数

isoline

True=1 : 等値線 False=0 : シェーディング

void ResultDefinition::SetLogScale ( bool  logscale )

inherited

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

引数

logscale

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

void ResultDefinition::SetModelCopy ( bool  on )

inherited

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

引数

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

void ResultDefinition::SetName ( String &  name )

inherited

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

引数

name

プロットの名称

void ResultDefinition::SetNumLabels ( Variant &  labels )

inherited

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

引数

labels

ラベル数

void ResultDefinition::SetPrecision ( Variant &  precision )

inherited

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

引数

precision

小数点以下の表示桁数

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

inherited

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

引数

min	最小値
max	最大値

void ContourDefinition::SetReferenceStep

(

Variant &

step

)

参照ステップ番号を指定します。これはパーミアンスの計算に使用されます。

引数

step

ステップ番号

void ResultDefinition::SetResultCoordinate ( Variant &  name )

inherited

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

引数

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

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

virtual

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

引数

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

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

ResultDefinitionを再実装しています。

void ContourDefinition::SetResultUnit

(

String &

name

)

結果の単位を設定します。

引数

name

結果の単位

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

inherited

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

引数

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

void ContourDefinition::SetScaleByParts

(

bool

scaleByParts

)

スケーリングを表示モデルの最大/最小値から決めるかどうかを指定します。

引数

scaleByParts

True=1 : 決める False=0 : 決めない

void ResultDefinition::SetScalingFactor ( Condition *  cond )

inherited

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

引数

cond	Condition オブジェクト

void ContourDefinition::SetTemperature

(

Variant &

value

)

温度を設定します。

引数

value

温度

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

void ResultDefinition::SetTransparencyNonTarget ( bool  on )

inherited

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

引数

on

透明度のオン/オフ

void ResultDefinition::SetTransparencyValueNonTarget ( Variant &  value )

inherited

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

引数

value

透明度(0~100)

void ContourDefinition::SetUserComponentType

(

String &

name

)

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

引数

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

void ResultDefinition::SetUseSpecifiedPosition ( bool  useSpecifiedPosition )

inherited

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

引数

useSpecifiedPosition

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

void ResultDefinition::SetViewIndex ( Variant &  index )

inherited

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

引数

index

視点のインデックス

void ResultDefinition::SetViewName ( Variant &  name )

inherited

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

引数

name

視点の名前

void ResultDefinition::SetViewOriginalModel ( bool  on )

inherited

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

引数

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

void ResultDefinition::SetViewPoint ( bool  on )

inherited

視点を設定します。

引数

on

視点のオン/オフ

void ResultDefinition::SetViewScale ( bool  on )

inherited

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

引数

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