CompositeResultDefinition Class is used to specify composite result items.
The class can be called from Study class.
. More...

Public Member Functions
void	ClearResults ()
	Clears the result items for composite result.

String	GetName ()
	Returns the name of the composite result as a string. More...

bool	IsValid ()
	Returns True if an object is valid. More...

void	SetContourDefinition (ContourDefinition *contour)
	Specifies the ContourDefinition object for composite result. More...

void	SetDisplayDefinition (Variant &var)
	Specifies the name or index of the result item for display setting. More...

void	SetFluxLineDefinition (FluxLineDefinition *flux)
	Specifies the FluxLineDefinition object for composite result. More...

void	SetName (String &name)
	Specifies the name of the composite result. More...

void	SetVectorDefinition (VectorDefinition *vector)
	Specifies the VectorDefinition object for composite result. More...

Detailed Description

CompositeResultDefinition Class is used to specify composite result items.
The class can be called from Study class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetCompositeResult(0)

Member Function Documentation

String CompositeResultDefinition::GetName ( )

Returns the name of the composite result as a string.

bool CompositeResultDefinition::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the CompositeResultDefinition objects in the list are valid

void CompositeResultDefinition::SetContourDefinition ( ContourDefinition * contour )

Specifies the ContourDefinition object for composite result.

Parameters

ContourDefinition object

void CompositeResultDefinition::SetDisplayDefinition ( Variant & var )

Specifies the name or index of the result item for display setting.

Parameters

name	Name or index of the result item

void CompositeResultDefinition::SetFluxLineDefinition ( FluxLineDefinition * flux )

Specifies the FluxLineDefinition object for composite result.

Parameters

FluxLineDefinition object

void CompositeResultDefinition::SetName ( String & name )

Specifies the name of the composite result.

Parameters

name	Composite result name

void CompositeResultDefinition::SetVectorDefinition ( VectorDefinition * vector )

Specifies the VectorDefinition object for composite result.

Parameters

VectorDefinition object