Public Member Functions | List of all members
ExpressionItem Class Reference

ExpressionItem Class is used to obtain or specify the information for the optimization constraint conditions.
The class can be called from OptimizationTable class.
. More...

Public Member Functions

String GetExpression ()
 Returns the constraint condition expression as a string. More...
 
String GetName ()
 Returns a constraint condition name as a string. More...
 
String GetTitle ()
 Returns an expression title as a string. More...
 
String GetType ()
 Returns the type of expression as a string. More...
 
double GetValue ()
 Returns the design variable value as a numerical value. More...
 
double GetWeight ()
 Returns the weight of the objective function as a numerical value. More...
 
bool IsExpression ()
 Returns True if the expression item is a simple expression. Returns False for constraints and objective functions.
 
bool IsValid ()
 Returns True as the return value if an object is valid. More...
 
void SetExpression (String &exp)
 Specifies the constraint condition expression as a string. More...
 
void SetIsExpression (bool isExpression)
 Specifies True if the expression is a simple expression not a constraint or objective function. More...
 
void SetName (String &name)
 Specifies the name of the constraint condition as a string. More...
 
void SetTitle (String &title)
 Specifies the title of the expression as a string. More...
 
void SetType (Variant &type)
 Specifies the type of constraint condition. (<=, >=, ==, minimize or maximize) More...
 
void SetValue (double value)
 Specifies the design variable value as a numerical value. More...
 
void SetWeight (double weight)
 Specifies the weight of the objective function as a numerical value. More...
 

Detailed Description

ExpressionItem Class is used to obtain or specify the information for the optimization constraint conditions.
The class can be called from OptimizationTable class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetOptimizationTable().GetExpressionItem(0)

Member Function Documentation

String ExpressionItem::GetExpression ( )

Returns the constraint condition expression as a string.

Returns
Constraint condition expression
String ExpressionItem::GetName ( )

Returns a constraint condition name as a string.

Returns
Name of the constraint condition
String ExpressionItem::GetTitle ( )

Returns an expression title as a string.

Returns
Title of the expression
String ExpressionItem::GetType ( )

Returns the type of expression as a string.

Returns
Constraint condition type
double ExpressionItem::GetValue ( )

Returns the design variable value as a numerical value.

Returns
Design variable value
double ExpressionItem::GetWeight ( )

Returns the weight of the objective function as a numerical value.

Returns
Weight of objective function
bool ExpressionItem::IsValid ( )

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

Returns
Whether or not the ExpressionItem object is valid
void ExpressionItem::SetExpression ( String &  exp)

Specifies the constraint condition expression as a string.

Parameters
expconstraint condition expression
void ExpressionItem::SetIsExpression ( bool  isExpression)

Specifies True if the expression is a simple expression not a constraint or objective function.

Parameters
isExpressionWhether the expression is a simple expression or not.
void ExpressionItem::SetName ( String &  name)

Specifies the name of the constraint condition as a string.

Parameters
nameName of the constraint condition
void ExpressionItem::SetTitle ( String &  title)

Specifies the title of the expression as a string.

Parameters
titleTitle of expression
void ExpressionItem::SetType ( Variant &  type)

Specifies the type of constraint condition. (<=, >=, ==, minimize or maximize)

Parameters
typeType of constraint condition
void ExpressionItem::SetValue ( double  value)

Specifies the design variable value as a numerical value.

Parameters
valueDesign variable value
void ExpressionItem::SetWeight ( double  weight)

Specifies the weight of the objective function as a numerical value.

Parameters
weightWeight of objective function