Report Class Reference

Report class is used to obtain a report.
The class can be called from Study class.
. More...

Public Member Functions
void	ExportMessagesForAllCases (String &filename)
	Exports result information for multiple cases to a CSV file. More...
String	GetCalculationFolder ()
	Returns the name of the temporary folder used for calculation as a string. More...
Message *	GetErrorMessage (int index)
	Returns an error message by specifying the index. More...
String	GetGraphDescription (String &graphName)
	Returns the description of the specified graph. More...
Variant	GetGraphNames ()
	Returns the graph names as a string list. More...
Message *	GetMessageObject (int index)
	Returns the Message object by specifying the index. More...
Variant	GetPropertyNames ()
	Returns a string list of the property names. More...
String	GetValue (String &propName, String &subName=String("graph"))
	Returns property value as a real number. More...
Message *	GetWarningMessage (int index)
	Returns a warning message by specifying the index. More...
bool	HasErrorMessage ()
	Returns True as a return value if there is an error message. More...
bool	HasWarningMessage ()
	Returns True as a return value if there is a warning message. More...
bool	IsValid ()
	Returns True if an object is valid. More...
int	NumElements ()
	Returns the number of elements in the mesh as an integer. More...
int	NumErrorMessages ()
	Returns the number of error messages as an integer. More...
int	NumMessages ()
	Returns the number of messages as an integer. More...
int	NumVertices ()
	Returns the number of nodes in the mesh as an integer. More...
int	NumViewCapture ()
	Returns the number of captured images. More...
int	NumWarningMessages ()
	Returns the number of warning messages as an integer. More...
bool	RemoveViewCapture (Variant &val)
	Deletes the captured images. Specify the name or index of the image to be deleted. More...
bool	SetGraphDescription (String &graphName, String &description)
	Specifies the description of the specified graph. More...
void	SetValue (String &propName, String &val)
	Specifies a property value. More...
bool	SetViewCaptureComment (Variant &val, String &comment)
	Changes the comment of the captured image. Specify the name or index of the image to modify the comment. More...
bool	SetViewCaptureTitle (Variant &val, String &newTitle)
	Changes the title of the captured image. Specify the name or index of an image to modify the title. More...
bool	WriteCaseReport (String &filename)
	Exports a case report. More...
bool	WriteParametricReport (String &filename)
	Exports a parametric report. More...

Detailed Description

Report class is used to obtain a report.
The class can be called from Study class.
.

Example of obtaining the class object:

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

Member Function Documentation

void Report::ExportMessagesForAllCases

(

String &

filename

)

Exports result information for multiple cases to a CSV file.

Parameters

filename

CSV file path to export

String Report::GetCalculationFolder

(

)

Returns the name of the temporary folder used for calculation as a string.

Returns

Temporary folder used for calculation

Message * Report::GetErrorMessage

(

int

index

)

Returns an error message by specifying the index.

Parameters

index

Message index

Returns

Message object

String Report::GetGraphDescription

(

String &

graphName

)

Returns the description of the specified graph.

Parameters

graphName

Graph name

Returns

Description

Variant Report::GetGraphNames

(

)

Returns the graph names as a string list.

Returns

Graph name list

Message * Report::GetMessageObject

(

int

index

)

Returns the Message object by specifying the index.

Parameters

index

Message index

Returns

Message object

Variant Report::GetPropertyNames

(

)

Returns a string list of the property names.

Returns

Property name list

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

Returns property value as a real number.

Parameters

propName	Property name
subName	SubName

Returns

Property value

For information about the condition type name that can be specified as propName , see Settings Specified in the Report Properties .

Message * Report::GetWarningMessage

(

int

index

)

Returns a warning message by specifying the index.

Parameters

index

Message index

Returns

Message object

bool Report::HasErrorMessage

(

)

Returns True as a return value if there is an error message.

Returns

Existence of an error message

bool Report::HasWarningMessage

(

)

Returns True as a return value if there is a warning message.

Returns

Existence of a warning message

bool Report::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the Report object is valid

int Report::NumElements

(

)

Returns the number of elements in the mesh as an integer.

Returns

Number of elements in the mesh

int Report::NumErrorMessages

(

)

Returns the number of error messages as an integer.

Returns

Number of error messages

int Report::NumMessages

(

)

Returns the number of messages as an integer.

Returns

Number of messages

int Report::NumVertices

(

)

Returns the number of nodes in the mesh as an integer.

Returns

Number of nodes in the mesh

int Report::NumViewCapture

(

)

Returns the number of captured images.

Returns

Number of captured images

int Report::NumWarningMessages

(

)

Returns the number of warning messages as an integer.

Returns

Number of warning messages

bool Report::RemoveViewCapture

(

Variant &

val

)

Deletes the captured images. Specify the name or index of the image to be deleted.

Parameters

val	Title or index of the captured image

Returns

Whether or not the image has been deleted

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

Specifies the description of the specified graph.

Parameters

graphName	Graph name
description	Description

Returns

Whether or not the description has been specified

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

Specifies a property value.

Parameters

propName	Property name
val	Value of properties

For information about the condition type name that can be specified as propName , see Settings Specified in the Report Properties .

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

Changes the comment of the captured image. Specify the name or index of the image to modify the comment.

Parameters

val	Title or index of the captured image
comment	New comment

Returns

Whether or not the comment has been modified

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

Changes the title of the captured image. Specify the name or index of an image to modify the title.

Parameters

val	Title or index of the captured image
newTitle	New title

Returns

Whether or not the title has been changed

bool Report::WriteCaseReport

(

String &

filename

)

Exports a case report.

Parameters

filename

File name of report to export

Returns

Whether or not the case report is exported successfully

bool Report::WriteParametricReport

(

String &

filename

)

Exports a parametric report.

Parameters

filename

File name of report to export

Returns

Whether or not the parametric report is exported successfully