ResultCalculation Class Reference

ResultCalculation class is used to specify properties for the calculation processing of results (physical amounts).
The class can be created from a Study class.
. More...

Public Member Functions
void	AddResultType (String &scriptName)
	Adds the result type. More...
void	ClearResultType ()
	Clears the result type.
int	GetExecuteType ()
	Returns the automatic calculation type. More...
String	GetName ()
	Returns name of calculation item as a string. More...
Variant	GetValue (String &propName)
	Specifies the property name and obtains its value. More...
bool	IsValid ()
	Returns True if an object is valid. More...
void	RunCalculation (bool allCases)
	Runs a calculation. More...
void	SetExecuteType (int type)
	Specifies the automatic calculaton type. More...
void	SetName (String &name)
	Specifies the name of the calculation. More...
void	SetValue (String &propName, Variant &value)
	Specifies the value of the calculation property. More...

Detailed Description

ResultCalculation class is used to specify properties for the calculation processing of results (physical amounts).
The class can be created from a Study class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetCalculation(0)

The following functions are applicable.

• Fourier Transformation
• Frequency Filter Calculation
• Calculation of Result Difference

Member Function Documentation

void ResultCalculation::AddResultType

(

String &

scriptName

)

Adds the result type.

Parameters

scriptName

Result type name

int ResultCalculation::GetExecuteType

(

)

Returns the automatic calculation type.

Returns

0 ： Do not automatically calculate
1 ： Run an automatic calculation for the entire case
2 ： Run an automatic calculation for the current case

String ResultCalculation::GetName

(

)

Returns name of calculation item as a string.

Returns

Name of the calculation item

Variant ResultCalculation::GetValue

(

String &

propName

)

Specifies the property name and obtains its value.

Parameters

propName

Property name

Returns

Value

For information about property names, see Properties and Flags for Calculating Results .

bool ResultCalculation::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the ResultCalculation objects in the list are valid

void ResultCalculation::RunCalculation

(

bool

allCases

)

Runs a calculation.

Parameters

allCases

Flag for running all cases True ： Run all cases False ： Run current case

void ResultCalculation::SetExecuteType

(

int

type

)

Specifies the automatic calculaton type.

Parameters

type	0 ： Do not automatically calculate 1 ： Run an automatic calculation for the entire case 2 ： Run an automatic calculation for the current case

void ResultCalculation::SetName

(

String &

name

)

Specifies the name of the calculation.

Parameters

name	Name of the calculation item

void ResultCalculation::SetValue	(	String &	propName,
		Variant &	value
	)

Specifies the value of the calculation property.

Parameters

propName	Property name
value	Value

For information about property names, see Properties and Flags for Calculating Results .