CurrentResult Class Reference

The CurrentResult class manages the result of the current case of the current study.
. More...

Public Member Functions
Variant	GetResponseData (String &name)
	Returns all variable values for a single case response value calculation. More...
double	GetResponseVariable (String &name)
	Returns a value of a response value variable. More...
String	GetResultFileName ()
	Returns the result file name (*.jplot, *.plot). More...
DataSet *	GetTableDataSet (String &name)
	Returns a DataSet object by specifying a name. More...
double	GetValue (String &name)
	Returns the value of a variable that cannot be retrieved with GetVariableValue. More...
double	GetVariableValue (String &name)
	Returns the value of a study variable. More...
bool	IsValid ()
	Returns True if an object is valid. More...

Detailed Description

The CurrentResult class manages the result of the current case of the current study.
.

Example of calling the class object:

app..GetCurrentResult()

Member Function Documentation

Variant CurrentResult::GetResponseData

(

String &

name

)

Returns all variable values for a single case response value calculation.

Parameters

name	Name of the response variable

Returns

List of values

double CurrentResult::GetResponseVariable

(

String &

name

)

Returns a value of a response value variable.

Parameters

name	Name of the response variable

Returns

Variable value

String CurrentResult::GetResultFileName

(

)

Returns the result file name (*.jplot, *.plot).

Attention

If the output contains multiple result files, the main output file name for the studies or cases are output.
For example, when using multi slice conditions for a magnetic study, the output contains not only a main result file "Designer.jplot", but also the sub result files such as "Designer_slice_1.jplot" and "Designer_slice_2.jplot."

Returns

Path to the result file

DataSet * CurrentResult::GetTableDataSet

(

String &

name

)

Returns a DataSet object by specifying a name.

Parameters

name	Data set name

Returns

DataSet object

See Properties for the Table Display for the physical quantities that can be specified as arguments.

double CurrentResult::GetValue

(

String &

name

)

Returns the value of a variable that cannot be retrieved with GetVariableValue.

Parameters

name

Variable name Winding$N@Resistor: Phase resistance name for the Nth winding setting Winding$N@Turns: Number of turns for the Nth winding setting Winding$N@WireDiameter: Wire diameter for the Nth winding setting Winding$N@WireWidth: Wire width for the Nth winding setting Winding$N@WireHeight: Wire height for the Nth winding setting Winding$N@FillFactor: Slot fill factor for the Nth winding setting Winding$N@Layers: Number of layers for the Nth winding setting Winding$N@InsulationThickness: Insulation thickness for the Nth winding setting Winding@ParallelNumber: Parallel number for the Nth winding setting

Returns

Variable value

The following are examples. In this example, the phase resistance of the second winding setting in the study is obtained.

resistor = currentResult.GetValue("Winding2@Resistor")

double CurrentResult::GetVariableValue

(

String &

name

)

Returns the value of a study variable.

Parameters

name	Variable name

Returns

Variable value

bool CurrentResult::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the CurrentResult object in the list is valid