ParametricEquation class is used to call parametric equations.
The class can be called from DesignTable class.
. More...

Public Member Functions
String	GetDescription ()
	Returns the description of parametric equation as a string. More...

int	GetDisplayIndex ()
	Returns the display index of a parametric equation. More...

String	GetDisplayName ()
	Returns the display name of parametric equation. More...

String	GetExpression ()
	Returns a parametric equation as a string. More...

String	GetFalseValue ()
	Returns the False value of the parametric equation. More...

bool	GetModeling ()
	Returns the flag to use parametric equations for modeling. More...

String	GetName ()
	Returns the name of a parametric equation as a string. More...

String	GetTrueValue ()
	Returns the True value of the parametric equation. More...

int	GetType ()
	Returns a parametric equation type as an integer. More...

double	GetValue (int caseIndex=-1)
	Returns the value of parametric equation. More...

bool	IsValid ()
	Returns True as a return value if the object is valid. More...

void	SetDescription (String &description)
	Specifies a description for a parametric equation. More...

void	SetDisplayIndex (int displayIndex)
	Specifies display index for a parametric equation. More...

void	SetDisplayName (String &name)
	Specifies a display name for a parametric equation. More...

void	SetExpression (String &exp)
	Specifies an expression for a parametric equation. More...

void	SetFalseValue (String &value)
	Specifies the False value of the parametric equation. More...

void	SetModeling (bool isModeling)
	Specifies whether to use for modeling parametric equations. More...

void	SetName (String &name)
	Specifies the name of a parametric equation. More...

void	SetTrueValue (String &value)
	Specifies the True value of the parametric equation. More...

void	SetType (int type)
	Specifies the type of parametric equation. More...

Detailed Description

ParametricEquation class is used to call parametric equations.
The class can be called from DesignTable class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetDesignTable().GetEquation(0)

Member Function Documentation

String ParametricEquation::GetDescription ( )

Returns the description of parametric equation as a string.

Returns: Description of parametric equation

int ParametricEquation::GetDisplayIndex ( )

Returns the display index of a parametric equation.

Returns: The index for parametric equation for display

String ParametricEquation::GetDisplayName ( )

Returns the display name of parametric equation.

Returns: Display name of parametric equation

String ParametricEquation::GetExpression ( )

Returns a parametric equation as a string.

Returns: Expression of parametric equation

String ParametricEquation::GetFalseValue ( )

Returns the False value of the parametric equation.

Returns: False value of parametric equation

bool ParametricEquation::GetModeling ( )

Returns the flag to use parametric equations for modeling.

Returns: Flag to use for modeling

String ParametricEquation::GetName ( )

Returns the name of a parametric equation as a string.

Returns: Name of the parametric equation

String ParametricEquation::GetTrueValue ( )

Returns the True value of the parametric equation.

Returns: True value of parametric equation

int ParametricEquation::GetType ( )

Returns a parametric equation type as an integer.

0 : value

1 : expression

Returns: Type of parametric equation

double ParametricEquation::GetValue ( int caseIndex = -1 )

Returns the value of parametric equation.

Case index
>= 0 : value of parametric equation in selected case
-1 or non-argument: value of parametric equation in current case

Returns: Value of parametric equation

The caseIndex is numbered from 0.

bool ParametricEquation::IsValid ( )

Returns True as a return value if the object is valid.

Returns: Whether or not the parametric equation object is valid

void ParametricEquation::SetDescription ( String & description )

Specifies a description for a parametric equation.

Parameters

description Description of parametric equation

void ParametricEquation::SetDisplayIndex ( int displayIndex )

Specifies display index for a parametric equation.

Parameters

displayIndex The index for parametric equation for display

void ParametricEquation::SetDisplayName ( String & name )

Specifies a display name for a parametric equation.

Parameters

name	Display name of parametric equation

void ParametricEquation::SetExpression ( String & exp )

Specifies an expression for a parametric equation.

For example, when setting a value of 10, "10" should be entered in SetExpression().

SetExpression("10")

Parameters

exp	Expression of parametric equation

void ParametricEquation::SetFalseValue ( String & value )

Specifies the False value of the parametric equation.

Parameters

value False value of parametric equation

void ParametricEquation::SetModeling ( bool isModeling )

Specifies whether to use for modeling parametric equations.

Parameters

isModeling Flag to use for modeling

void ParametricEquation::SetName ( String & name )

Specifies the name of a parametric equation.

Parameters

name	Name of the parametric equation

void ParametricEquation::SetTrueValue ( String & value )

Specifies the True value of the parametric equation.

Parameters

value True value of parametric equation

void ParametricEquation::SetType ( int type )

Specifies the type of parametric equation.

Parameters

type	Type of parametric equation (0= value/1= expression)

Public Member Functions

Detailed Description

Member Function Documentation