公開メンバ関数 | 全メンバ一覧
CalculationDefinition クラス

CalculationDefinition クラスは 結果に対して計算処理(部品・面・エッジ計算の追加)を行う場合に使用します。
Study クラスから呼び出すことができます。
. [詳解]

公開メンバ関数

void AddGroup (MeshGroup *set, int group=0)
 MeshGroup オブジェクトを計算対象に追加します。 [詳解]
 
void AddSelected (Selection *selection)
 Selection オブジェクトで選択されている部品、面、またはエッジを、計算対象に追加します。 [詳解]
 
void AddSet (Set *set, int group=0)
 Set オブジェクトを計算対象に追加します。 [詳解]
 
void AddSetFromModel (Variant &val, int group=0)
 指定した名称またはインデックスをもつセットを計算対象に追加します。 [詳解]
 
void AddTarget (String &name)
 計算対象に任意断面・任意エッジを追加します。 [詳解]
 
void ClearParts ()
 計算対象から、すべての部品、面、またはエッジを除きます。
 
void ClearTargets ()
 計算対象から、全ての任意断面・任意エッジを削除します。
 
String GetCalculationType ()
 計算方法を取得します。 [詳解]
 
StringList GetCalculationTypeNames ()
 計算方法の一覧を取得します。 [詳解]
 
DataSetGetCaseDataSet (int caseno)
 指定したケースの DataSet オブジェクトを取得します。 [詳解]
 
String GetComponent ()
 指定した名称またはインデックスの CalculationDefinition オブジェクトを取得します。計算のプロパティを操作したい時に使います。 [詳解]
 
Variant GetComponentNames ()
 成分のリストを取得します。 [詳解]
 
DataSetGetDataSet ()
 DataSet オブジェクトを取得します。 [詳解]
 
PointGetDirectionAxis ()
 方向座標を取得します。
 
bool GetDirectionReverse ()
 線積分・面積分の場合にエッジ・面方向を反転させるかを取得します。
 
bool GetFullModelExpansion ()
 フルモデルの拡張を使うかどうか。
 
String GetName ()
 タイトルを取得します。 [詳解]
 
int GetNumCopies ()
 コピーの回数を取得します。
 
double GetOffsetAngle ()
 回転のオフセットを取得します。
 
double GetOffsetTranslation ()
 移動のオフセットを取得します。
 
PointGetOrigin ()
 原点座標を取得します。
 
Variant GetParts ()
 部品、面、またはエッジのIDのリストを、点列形式で取得します。 [詳解]
 
double GetPhase ()
 位相を取得します。 [詳解]
 
String GetPhaseType ()
 位相タイプを取得します。 [詳解]
 
int GetReferenceStep ()
 参照ステップを取得します。 [詳解]
 
String GetResultCoordinateName ()
 使用されている座標系の名称を取得します。 [詳解]
 
String GetResultCoordinateNameList ()
 使用できる座標系の一覧を取得します。 [詳解]
 
String GetResultType ()
 結果のタイプの名称を、文字列で取得します。 [詳解]
 
Variant GetResultTypeNames ()
 結果のタイプの名称リストを取得します。 [詳解]
 
double GetScaleFactor ()
 スケールファクタを取得します。 [詳解]
 
SelectionGetSelection ()
 計算対象に含まれる部品、面、またはエッジを Selection オブジェクトとして取得します。 [詳解]
 
SetGetSet (int index, int group=0)
 指定した名称またはインデックスをもつ、計算の対象に含まれるセットを取得します。 [詳解]
 
double GetTemperature ()
 温度を取得します。 [詳解]
 
double GetThreshold ()
 境界値を取得します。 [詳解]
 
String GetUserComponentType ()
 結果タイプで選択されているユーザーコンポーネントを取得します。 [詳解]
 
bool IsOneResultPerSet ()
 セットごとに結果を分けるかどうか。
 
bool IsValid ()
 オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
 
int NumSets (int group=0)
 指定した名称またはインデックスをもつ計算の対象に含まれるセット数を取得します。 [詳解]
 
void RemoveAllSets (int group=0)
 計算対象を指定して、そこに含まれるすべてのセットを計算対象から外します。 [詳解]
 
void RemoveSet (Variant &val, int group=0)
 指定した名称またはインデックスをもつセットを、計算対象から外します。 [詳解]
 
void SetCalculationType (String &name)
 計算方法を指定します。 [詳解]
 
void SetComponent (String &name)
 コンポーネント名を指定します。 [詳解]
 
void SetDirectionAxis (double x, double y, double z)
 パターンコピーの方向座標を指定します。 [詳解]
 
void SetDirectionReverse (bool reverse)
 線積分・面積分の場合にエッジ・面方向を反転させるかを設定します。 [詳解]
 
void SetFullModelExpansion (bool useFullModelExpansion)
 フルモデルの拡張を使用します。 [詳解]
 
void SetHistoryAllSteps ()
 ヒストリ関数の参照範囲をすべてのステップに設定します。
 
void SetHistorySteps (String array &steps)
 ヒストリ関数の参照範囲となるステップを指定します。 [詳解]
 
void SetHistoryStepsByString (String &str)
 ヒストリ関数の参照範囲となるステップを文字列によって複数設定します。
[詳解]
 
void SetName (String &name)
 タイトルを指定します。 [詳解]
 
void SetNumCopies (Variant &numCopies)
 パターンコピーの回数を設定します。 [詳解]
 
void SetOffsetAngle (Variant &offsetAngle)
 回転のオフセットを設定します。 [詳解]
 
void SetOffsetTranslation (Variant &offsetTranslation)
 移動のオフセットを設定します。 [詳解]
 
void SetOneResultPerSet (bool oneResultPerSet)
 セットごとに結果を分けます。 [詳解]
 
void SetOrigin (double x, double y, double z)
 原点座標を指定します。 [詳解]
 
void SetPhase (double value)
 位相を設定します。 [詳解]
 
void SetPhaseType (Variant &value)
 位相タイプを設定します。 [詳解]
 
void SetReferenceStep (Variant &step)
 参照ステップを設定します。 [詳解]
 
void SetResultCoordinate (Variant &name)
 名称またはインデックスを指定して、使用する座標系を設定します。 [詳解]
 
void SetResultType (String &typeName, String &sourceTitle=String())
 結果のタイプを設定します。 [詳解]
 
void SetScaleFactor (Variant &scaleFactor)
 スケールファクタを指定します。 [詳解]
 
void SetTemperature (Variant &value)
 温度を設定します。 [詳解]
 
void SetThreshold (Variant &value)
 境界値を指定します。 [詳解]
 
void SetUseFullModelConversion (bool use)
 フルモデル換算を考慮するかどうかを設定します。 [詳解]
 
void SetUsePatternCopy (bool usePatternCopy)
 自動でパターンコピーを使用します。 [詳解]
 
void SetUserComponentType (String &name)
 使用するユーザーコンポーネントを設定します。 [詳解]
 
void SetUseRotationCopy (bool useRotationCopy)
 回転か移動のパターンコピーを設定します。 [詳解]
 
bool UseFullModelConversion ()
 フルモデル換算を考慮するかどうかを取得します。
 
bool UsePatternCopy ()
 自動でパターンコピーを使うかどうか。
 
bool UseRotationCopy ()
 回転パターンコピーか移動パターンコピーを使用します。
 

詳解

CalculationDefinition クラスは 結果に対して計算処理(部品・面・エッジ計算の追加)を行う場合に使用します。
Study クラスから呼び出すことができます。
.

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

app.GetModel(0).GetStudy(0).GetCalculationDefinition(0)

関数詳解

void CalculationDefinition::AddGroup ( MeshGroup set,
int  group = 0 
)

MeshGroup オブジェクトを計算対象に追加します。

引数
setMeshGroup オブジェクト
groupグループ

MeshGroup については MeshGroup を参照してください。

void CalculationDefinition::AddSelected ( Selection selection)

Selection オブジェクトで選択されている部品、面、またはエッジを、計算対象に追加します。

引数
selectionSelection オブジェクト(選択中の部品、面、エッジ)
void CalculationDefinition::AddSet ( Set set,
int  group = 0 
)

Set オブジェクトを計算対象に追加します。

引数
setSet オブジェクト
groupグループ

Set については Set および SetList を参照してください。

void CalculationDefinition::AddSetFromModel ( Variant &  val,
int  group = 0 
)

指定した名称またはインデックスをもつセットを計算対象に追加します。

引数
valセット名またはインデックス
groupグループ
void CalculationDefinition::AddTarget ( String &  name)

計算対象に任意断面・任意エッジを追加します。

引数
name計算対象の名前
String CalculationDefinition::GetCalculationType ( )

計算方法を取得します。

戻り値
文字列
計算方法
max : 最大値
min : 最小値
range : 範囲 (最大値-最小値)
sum : 合計
average : 単純平均
integral_average : 積分平均
integral : 積分
surface_integral : 面積分
line_integral : 線積分
below_threshold : 境界値以下の値
above_threshold : 境界値以上の値
StringList CalculationDefinition::GetCalculationTypeNames ( )

計算方法の一覧を取得します。

戻り値
文字列配列
DataSet * CalculationDefinition::GetCaseDataSet ( int  caseno)

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

引数
casenoケース番号
戻り値
DataSet オブジェクト

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

String CalculationDefinition::GetComponent ( )

指定した名称またはインデックスの CalculationDefinition オブジェクトを取得します。計算のプロパティを操作したい時に使います。

引数
val名称またはインデックス
戻り値
CalculationDefinition オブジェクト
Variant CalculationDefinition::GetComponentNames ( )

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

戻り値
文字列配列
DataSet * CalculationDefinition::GetDataSet ( )

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

戻り値
DataSet オブジェクト

DataSet については DataSet を参照してください。

String CalculationDefinition::GetName ( )

タイトルを取得します。

戻り値
タイトル (文字列)
Variant CalculationDefinition::GetParts ( )

部品、面、またはエッジのIDのリストを、点列形式で取得します。

戻り値
部品, 面, エッジのIDリスト
double CalculationDefinition::GetPhase ( )

位相を取得します。

戻り値
位相
String CalculationDefinition::GetPhaseType ( )

位相タイプを取得します。

戻り値
位相タイプ
"RealImag" = 実部と虚部を表示
"AmplitudePhase" = 振幅と位相を表示
"FixedPhase" = 位相指定
int CalculationDefinition::GetReferenceStep ( )

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

戻り値
参照ステップ番号

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

String CalculationDefinition::GetResultCoordinateName ( )

使用されている座標系の名称を取得します。

戻り値
座標系の名称
String CalculationDefinition::GetResultCoordinateNameList ( )

使用できる座標系の一覧を取得します。

戻り値
座標系の名称一覧
String CalculationDefinition::GetResultType ( )

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

戻り値
結果のタイプの名称
Variant CalculationDefinition::GetResultTypeNames ( )

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

戻り値
結果のタイプの名称リスト
double CalculationDefinition::GetScaleFactor ( )

スケールファクタを取得します。

戻り値
スケールファクター
Selection * CalculationDefinition::GetSelection ( )

計算対象に含まれる部品、面、またはエッジを Selection オブジェクトとして取得します。

戻り値
Selection オブジェクト
Set * CalculationDefinition::GetSet ( int  index,
int  group = 0 
)

指定した名称またはインデックスをもつ、計算の対象に含まれるセットを取得します。

引数
indexセットのインデックス
group計算対象グループ番号

Set については Set および SetList を参照してください。

double CalculationDefinition::GetTemperature ( )

温度を取得します。

戻り値
温度

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

double CalculationDefinition::GetThreshold ( )

境界値を取得します。

戻り値
境界値
String CalculationDefinition::GetUserComponentType ( )

結果タイプで選択されているユーザーコンポーネントを取得します。

戻り値
name ユーザーコンポーネント名
bool CalculationDefinition::IsValid ( )

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

戻り値
CalculationDefinition オブジェクトの有効・無効
int CalculationDefinition::NumSets ( int  group = 0)

指定した名称またはインデックスをもつ計算の対象に含まれるセット数を取得します。

引数
group計算対象グループ番号
戻り値
セット数
void CalculationDefinition::RemoveAllSets ( int  group = 0)

計算対象を指定して、そこに含まれるすべてのセットを計算対象から外します。

引数
group計算対象グループ番号
void CalculationDefinition::RemoveSet ( Variant &  val,
int  group = 0 
)

指定した名称またはインデックスをもつセットを、計算対象から外します。

引数
valセット名またはインデックス
group計算対象グループ番号
void CalculationDefinition::SetCalculationType ( String &  name)

計算方法を指定します。

引数
name
計算方法
max : 最大値
min : 最小値
range : 範囲 (最大値-最小値)
sum : 合計
average : 単純平均
integral_average : 積分平均
integral : 積分
surface_integral : 面積分
line_integral : 線積分
below_threshold : 境界値以下の値
above_threshold : 境界値以上の値
void CalculationDefinition::SetComponent ( String &  name)

コンポーネント名を指定します。

引数
nameコンポーネント名
void CalculationDefinition::SetDirectionAxis ( double  x,
double  y,
double  z 
)

パターンコピーの方向座標を指定します。

引数
xx-軸
yy-軸
zz-軸
void CalculationDefinition::SetDirectionReverse ( bool  reverse)

線積分・面積分の場合にエッジ・面方向を反転させるかを設定します。

引数
reverseエッジ・面の向きを反転する
void CalculationDefinition::SetFullModelExpansion ( bool  useFullModelExpansion)

フルモデルの拡張を使用します。

引数
useFullModelExpansionフルモデルの拡張を設定します
void CalculationDefinition::SetHistorySteps ( String array &  historySteps)

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

引数
historyStepsステップ
void CalculationDefinition::SetHistoryStepsByString ( String &  str)

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

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

引数
strステップ
void CalculationDefinition::SetName ( String &  name)

タイトルを指定します。

引数
name名前
void CalculationDefinition::SetNumCopies ( Variant &  numCopies)

パターンコピーの回数を設定します。

引数
numCopiesコピーの回数
void CalculationDefinition::SetOffsetAngle ( Variant &  offsetAngle)

回転のオフセットを設定します。

引数
offsetAngle回転のオフセット
void CalculationDefinition::SetOffsetTranslation ( Variant &  offsetTranslation)

移動のオフセットを設定します。

引数
offsetTranslation移動のオフセット
void CalculationDefinition::SetOneResultPerSet ( bool  oneResultPerSet)

セットごとに結果を分けます。

引数
oneResultPerSetセットごとに結果を分けるかどうかを設定します
void CalculationDefinition::SetOrigin ( double  x,
double  y,
double  z 
)

原点座標を指定します。

引数
xx-軸
yy-軸
zz-軸
void CalculationDefinition::SetPhase ( double  value)

位相を設定します。

引数
value位相
void CalculationDefinition::SetPhaseType ( Variant &  value)

位相タイプを設定します。

引数
value
位相タイプ
"RealImag" or "0" = 実部と虚部を表示
"AmplitudePhase" or "1" = 振幅と位相を表示
"FixedPhase" or "2" = 位相指定
void CalculationDefinition::SetReferenceStep ( Variant &  step)

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

引数
step参照ステップ番号

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

void CalculationDefinition::SetResultCoordinate ( Variant &  name)

名称またはインデックスを指定して、使用する座標系を設定します。

引数
name座標系の名称またはインデックス
void CalculationDefinition::SetResultType ( String &  typeName,
String &  sourceTitle = String() 
)

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

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

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

void CalculationDefinition::SetScaleFactor ( Variant &  scaleFactor)

スケールファクタを指定します。

引数
scaleFactorスケールファクタ
void CalculationDefinition::SetTemperature ( Variant &  value)

温度を設定します。

引数
value温度

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

void CalculationDefinition::SetThreshold ( Variant &  value)

境界値を指定します。

引数
value境界値
void CalculationDefinition::SetUseFullModelConversion ( bool  use)

フルモデル換算を考慮するかどうかを設定します。

引数
useフルモデル換算を考慮する
void CalculationDefinition::SetUsePatternCopy ( bool  usePatternCopy)

自動でパターンコピーを使用します。

引数
usePatternCopy自動でパターンコピーを使うかどうかを設定します
void CalculationDefinition::SetUserComponentType ( String &  name)

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

引数
nameユーザーコンポーネント名
void CalculationDefinition::SetUseRotationCopy ( bool  useRotationCopy)

回転か移動のパターンコピーを設定します。

引数
useRotationCopy回転か移動のパターンコピーを設定します