Report クラス

Report クラスはレポートの取得に使用します。
Study クラスから呼び出すことができます。
. [詳解]

公開メンバ関数
void	ExportMessagesForAllCases (String &filename)
	複数ケースの結果情報を、CSVファイルにエクスポートします。 [詳解]
String	GetCalculationFolder ()
	計算を行う一時フォルダの名称を、文字列で取得します。 [詳解]
Message *	GetErrorMessage (int index)
	インデックスを指定して、エラーメッセージを取得します。 [詳解]
String	GetGraphDescription (String &graphName)
	指定したグラフの説明を取得します。 [詳解]
Variant	GetGraphNames ()
	グラフ名を文字列リストで取得します。 [詳解]
Message *	GetMessageObject (int index)
	インデックスを指定して、Message オブジェクトを取得します。 [詳解]
Variant	GetPropertyNames ()
	プロパティの名称を文字列リストで取得します。 [詳解]
String	GetValue (String &propName, String &subName=String("graph"))
	プロパティの値を実数で取得します。 [詳解]
Message *	GetWarningMessage (int index)
	インデックスを指定して、警告メッセージを取得します。 [詳解]
bool	HasErrorMessage ()
	エラーメッセージがある場合、戻り値として True を取得します。 [詳解]
bool	HasWarningMessage ()
	警告メッセージがある場合、戻り値として True を取得します。 [詳解]
bool	IsValid ()
	オブジェクトが有効であるとき、戻り値として True を取得します。 [詳解]
int	NumElements ()
	メッシュの要素数を整数で取得します。 [詳解]
int	NumErrorMessages ()
	エラーメッセージの数を整数で取得します。 [詳解]
int	NumMessages ()
	メッセージの数を整数で取得します。 [詳解]
int	NumVertices ()
	メッシュの節点数を整数で取得します。 [詳解]
int	NumViewCapture ()
	キャプチャした画像の枚数を取得します。 [詳解]
int	NumWarningMessages ()
	警告メッセージの数を整数で取得します。 [詳解]
bool	RemoveViewCapture (Variant &val)
	キャプチャ画像を削除します。対象となる画像は、名称またはインデックスで指定します。 [詳解]
bool	SetGraphDescription (String &graphName, String &description)
	指定したグラフの説明を設定します。 [詳解]
void	SetValue (String &propName, String &val)
	プロパティの値を設定します。 [詳解]
bool	SetViewCaptureComment (Variant &val, String &comment)
	キャプチャ画像のコメントを変更します。対象となる画像は、名称またはインデックスで指定します。 [詳解]
bool	SetViewCaptureTitle (Variant &val, String &newTitle)
	キャプチャ画像のタイトルを変更します。対象となる画像は、名称またはインデックスで指定します。 [詳解]
bool	WriteCaseReport (String &filename)
	ケースレポートを書き出します。 [詳解]
bool	WriteParametricReport (String &filename)
	パラメトリックレポートを書き出します。 [詳解]

詳解

Report クラスはレポートの取得に使用します。
Study クラスから呼び出すことができます。
.

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

app.GetModel(0).GetStudy(0).GetReport()

関数詳解

void Report::ExportMessagesForAllCases

(

String &

filename

)

複数ケースの結果情報を、CSVファイルにエクスポートします。

引数

filename

出力するCSVファイルパス

String Report::GetCalculationFolder

(

)

計算を行う一時フォルダの名称を、文字列で取得します。

戻り値

計算を行う一時フォルダ

Message * Report::GetErrorMessage

(

int

index

)

インデックスを指定して、エラーメッセージを取得します。

引数

index

メッセージインデックス

戻り値

Message オブジェクト

String Report::GetGraphDescription

(

String &

graphName

)

指定したグラフの説明を取得します。

引数

graphName

グラフ名

戻り値

説明

Variant Report::GetGraphNames

(

)

グラフ名を文字列リストで取得します。

戻り値

グラフ名リスト

Message * Report::GetMessageObject

(

int

index

)

インデックスを指定して、Message オブジェクトを取得します。

引数

index

メッセージインデックス

戻り値

Message オブジェクト

Variant Report::GetPropertyNames

(

)

プロパティの名称を文字列リストで取得します。

戻り値

プロパティの名称リスト

String Report::GetValue	(	String &	propName,
		String &	subName = String("graph")
	)

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

引数

propName	プロパティ名
subName	SubName

戻り値

プロパティの値

propName として指定可能な条件タイプ名については レポートのプロパティ設定で使用するもの を参照してください。

Message * Report::GetWarningMessage

(

int

index

)

インデックスを指定して、警告メッセージを取得します。

引数

index

メッセージインデックス

戻り値

Message オブジェクト

bool Report::HasErrorMessage

(

)

エラーメッセージがある場合、戻り値として True を取得します。

戻り値

エラーメッセージの有無

bool Report::HasWarningMessage

(

)

警告メッセージがある場合、戻り値として True を取得します。

戻り値

警告メッセージの有無

bool Report::IsValid

(

)

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

戻り値

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

int Report::NumElements

(

)

メッシュの要素数を整数で取得します。

戻り値

メッシュの要素数

int Report::NumErrorMessages

(

)

エラーメッセージの数を整数で取得します。

戻り値

エラーメッセージの数

int Report::NumMessages

(

)

メッセージの数を整数で取得します。

戻り値

メッセージの数

int Report::NumVertices

(

)

メッシュの節点数を整数で取得します。

戻り値

メッシュの節点数

int Report::NumViewCapture

(

)

キャプチャした画像の枚数を取得します。

戻り値

キャプチャした画像の枚数

int Report::NumWarningMessages

(

)

警告メッセージの数を整数で取得します。

戻り値

警告メッセージの数

bool Report::RemoveViewCapture

(

Variant &

val

)

キャプチャ画像を削除します。対象となる画像は、名称またはインデックスで指定します。

引数

val	キャプチャ画像のタイトルまたはインデックス

戻り値

削除が成功したか否か

bool Report::SetGraphDescription	(	String &	graphName,
		String &	description
	)

指定したグラフの説明を設定します。

引数

graphName	グラフ名
description	説明

戻り値

設定が成功したか否か

void Report::SetValue	(	String &	propName,
		String &	val
	)

プロパティの値を設定します。

引数

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

propName として指定可能な条件タイプ名については レポートのプロパティ設定で使用するもの を参照してください。

bool Report::SetViewCaptureComment	(	Variant &	val,
		String &	comment
	)

キャプチャ画像のコメントを変更します。対象となる画像は、名称またはインデックスで指定します。

引数

val	キャプチャ画像のタイトルまたはインデックス
comment	新しいコメント

戻り値

変更が成功したか否か

bool Report::SetViewCaptureTitle	(	Variant &	val,
		String &	newTitle
	)

キャプチャ画像のタイトルを変更します。対象となる画像は、名称またはインデックスで指定します。

引数

val	キャプチャ画像のタイトルまたはインデックス
newTitle	新しいタイトル

戻り値

変更が成功したか否か

bool Report::WriteCaseReport

(

String &

filename

)

ケースレポートを書き出します。

引数

filename

書き出すレポートファイル名

戻り値

書き出しに成功したか否か

bool Report::WriteParametricReport

(

String &

filename

)

パラメトリックレポートを書き出します。

引数

filename

書き出すレポートファイル名

戻り値

書き出しに成功したか否か