TopologyObjectiveItem Class Reference

TopologyObjectiveItem Class is used to obtain or specify the information for the topology optimization objective functions.
The class can be called from OptimizationTable class.
. More...

Public Member Functions
String	GetResultType ()
	Returns the objective function result type as a string. More...
int	GetStudyIndex ()
	Returns the objective function study index. More...
String	GetTargetCondition ()
	Returns the objective function target condition name. More...
String	GetTargetGroup ()
	Returns the objective function target set/mesh group name. More...
String	GetType ()
	Returns the objective function type as a string. More...
double	GetValue ()
	Returns the value of the objective function. More...
double	GetWeight ()
	Returns the weight of the objective function as a numerical value. More...
bool	IsValid ()
	Returns True if the object is valid. More...
void	SetResultType (Variant &type)
	Specifies the name of the objective function result type as a string. More...
void	SetStudyIndex (int index)
	Specifies the study index of the objective function. More...
void	SetTargetCondition (String &exp)
	Specifies the objective function target condition name. More...
void	SetTargetGroup (String &exp)
	Specifies the objective function target set/mesh group name. More...
void	SetType (Variant &type)
	Specifies the type of objective function (minimize or maximize) More...
void	SetValue (double value)
	Specifies the value of the objective function. More...
void	SetWeight (double weight)
	Specifies the weight of the objective function as a numerical value. More...

Detailed Description

TopologyObjectiveItem Class is used to obtain or specify the information for the topology optimization objective functions.
The class can be called from OptimizationTable class.
.

Example of obtaining the class object:

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

Member Function Documentation

String TopologyObjectiveItem::GetResultType

(

)

Returns the objective function result type as a string.

Returns

Result type

int TopologyObjectiveItem::GetStudyIndex

(

)

Returns the objective function study index.

Returns

Study index

String TopologyObjectiveItem::GetTargetCondition

(

)

Returns the objective function target condition name.

Returns

Target condition name

String TopologyObjectiveItem::GetTargetGroup

(

)

Returns the objective function target set/mesh group name.

Returns

Target set/mesh group name

String TopologyObjectiveItem::GetType

(

)

Returns the objective function type as a string.

Returns

Objective function type

double TopologyObjectiveItem::GetValue

(

)

Returns the value of the objective function.

Returns

Value of objective function

double TopologyObjectiveItem::GetWeight

(

)

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

Returns

Weight of objective function

bool TopologyObjectiveItem::IsValid

(

)

Returns True if the object is valid.

Returns

Whether or not the TopologyObjectiveItem object is valid

void TopologyObjectiveItem::SetResultType

(

Variant &

name

)

Specifies the name of the objective function result type as a string.

Parameters

name	Name of the result type

void TopologyObjectiveItem::SetStudyIndex

(

int

index

)

Specifies the study index of the objective function.

Parameters

index

Study index

void TopologyObjectiveItem::SetTargetCondition

(

String &

exp

)

Specifies the objective function target condition name.

Parameters

exp	Target condition name

void TopologyObjectiveItem::SetTargetGroup

(

String &

exp

)

Specifies the objective function target set/mesh group name.

Parameters

exp	Target set/mesh group name

void TopologyObjectiveItem::SetType

(

Variant &

type

)

Specifies the type of objective function (minimize or maximize)

Parameters

type	Type of objective function

void TopologyObjectiveItem::SetValue

(

double

value

)

Specifies the value of the objective function.

Parameters

value

Value of objective function

void TopologyObjectiveItem::SetWeight

(

double

weight

)

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

Parameters

weight

Weight of objective function