ResponseTableDefinition class is used to specify a custom response table for the accuracy type efficiency map.
The class can be called from the Study class.
. More...

Public Member Functions
void	ClearLossItems ()
	Clears all currently set loss items.

bool	CustomizeLoss ()
	Returns whether to customize the loss. More...

String	FilterName ()
	Returns the title of the case filter. More...

bool	IncludeStandardComponent ()
	Returns whether the standard loss items are included in the custom table. More...

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

String	LossItemResult (int index)
	Returns the name of the expression or response data definition for the given loss item. More...

String	LossItemTitle (int index)
	Returns the title of the given loss result item. More...

String	Name ()
	Returns the result table definition name as a string. More...

void	SetCustomizeLoss (bool customize)
	Specifies whether to customize the loss. More...

void	SetFilter (Variant &filter)
	Specifies the case filter. More...

void	SetIncludeStandardComponent (bool include)
	Specifies whether to include standard loss items in the custom table. More...

void	SetLossItem (int index, String &title, String &name, bool subtractTorque=true)
	Specifies the title and the name of the expression or response data definition for the given loss item. More...

void	SetName (String &name)
	Specifies the name of the response table definition. More...

void	SetTotalLossResult (String &name, bool subtractTorque=false)
	Specifies the name of the expression or response data definition for the total loss. More...

void	SetType (Variant &type)
	Specifies the type of the table definition. The type is either "total" or "independent". More...

bool	SubtractTorque (int index)
	Returns whether the loss result is subtracted from the torque. More...

String	TotalLossResult ()
	Returns the name of the response data or expression used for the total loss result. More...

bool	TotalSubtractTorque ()
	Returns whether the total loss result is subtracted from the torque. More...

Detailed Description

ResponseTableDefinition class is used to specify a custom response table for the accuracy type efficiency map.
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetResponseTableDefinition(0)

Member Function Documentation

bool ResponseTableDefinition::CustomizeLoss ( )

Returns whether to customize the loss.

Returns: Whether to customize the loss

String ResponseTableDefinition::FilterName ( )

Returns the title of the case filter.

Returns: Case filter title

bool ResponseTableDefinition::IncludeStandardComponent ( )

Returns whether the standard loss items are included in the custom table.

Returns: Whether to include standard loss items in the custom table

bool ResponseTableDefinition::IsValid ( )

virtual

Returns True if an object is valid.

Returns: Whether or not the ResponseTableDefinition object is valid

String ResponseTableDefinition::LossItemResult ( int index )

Returns the name of the expression or response data definition for the given loss item.

Parameters

index The index of the loss result item

Returns: The name of the expression or response data definition

String ResponseTableDefinition::LossItemTitle ( int index )

Returns the title of the given loss result item.

Parameters

index The index of the loss result item

Returns: The title string

String ResponseTableDefinition::Name ( )

Returns the result table definition name as a string.

Returns: The name or the definition.

void ResponseTableDefinition::SetCustomizeLoss ( bool customize )

Specifies whether to customize the loss.

Parameters

customize Whether to customize the loss

void ResponseTableDefinition::SetFilter ( Variant & filter )

Specifies the case filter.

Parameters

filter Case filter title or index

void ResponseTableDefinition::SetIncludeStandardComponent ( bool include )

Specifies whether to include standard loss items in the custom table.

Parameters

include Whether to include standard loss items in the custom table

void ResponseTableDefinition::SetLossItem	(	int	index,
		String &	title,
		String &	name,
		bool	subtractTorque = `true`
	)

Specifies the title and the name of the expression or response data definition for the given loss item.

Parameters

index	The index of the loss result item
title	The title of the loss result item
name	The name of the expression or response data definition
subtractTorque	Whether to subtract the loss result from the torque

void ResponseTableDefinition::SetName ( String & name )

Specifies the name of the response table definition.

Parameters

name	The definition name

void ResponseTableDefinition::SetTotalLossResult	(	String &	name,
		bool	subtractTorque = `false`
	)

Specifies the name of the expression or response data definition for the total loss.

Parameters

name	The name of the expression or response data definition
subtractTorque	Whether to subtract the loss result from the torque

void ResponseTableDefinition::SetType ( Variant & type )

Specifies the type of the table definition. The type is either "total" or "independent".

Parameters

type	The type of the table definition.

bool ResponseTableDefinition::SubtractTorque ( int index )

Returns whether the loss result is subtracted from the torque.

Parameters

index The index of the loss result item

Returns: True if the loss will be subtracted from the torque

String ResponseTableDefinition::TotalLossResult ( )

Returns the name of the response data or expression used for the total loss result.

Returns: The name of the expression or response data definition

bool ResponseTableDefinition::TotalSubtractTorque ( )

Returns whether the total loss result is subtracted from the torque.

Returns: True if the total loss will be subtracted from the torque

Public Member Functions

Detailed Description

Member Function Documentation