ExternalEfficiencyMapDefinition class is used to specify the settings for an efficiency map of external data input.
The class can be called from the Study class.
. More...

Public Member Functions
void	ClearResultTypes ()
	Clears the result types for this efficiency map of external data input.

bool	GetCalculationLoss (int index)
	Returns an calculation loss type for this efficiency map of external data input by specifying the index. More...

int	GetInputType ()
	Returns the result table definition name as input type. More...

String	GetResultTypeName (int index)
	Returns an result type name for this efficiency map of external data input by specifying the index. More...

void	ImportFromMatrixTable (String &filename)
	Specifies a matrix type point sequence from a file in the efficiency map for external data input. More...

void	ImportFromMultiColumnTable (String &filename)
	Specifies multiple result type point sequence from file to efficiency map of external data input. More...

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

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

int	NumResultTypes ()
	Returns the number of result types for this efficiency map of external data input. More...

void	SetInputType (int type)
	Specifies the input type for this efficiency map of external data input. More...

void	SetMatrixTable (String array &array)
	Specifies a matrix type point sequence in the efficiency map of external data input. More...

void	SetMultiColumnTable (String array &array)
	Specifies multiple result type point sequence in the efficiency map of external data input. More...

void	SetName (String &title)
	Specifies the name for this efficiency map of external data input. More...

void	SetResultType (int index, String &resultName, bool loss)
	Specifies the result type for this efficiency map of external data input. More...

Detailed Description

ExternalEfficiencyMapDefinition class is used to specify the settings for an efficiency map of external data input.
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetExternalEfficiencyMapDefinition(0)

Member Function Documentation

bool ExternalEfficiencyMapDefinition::GetCalculationLoss ( int index )

Returns an calculation loss type for this efficiency map of external data input by specifying the index.

Parameters

index Index of the result type

Returns: Calculation loss type

int ExternalEfficiencyMapDefinition::GetInputType ( )

Returns the result table definition name as input type.

Returns: Input type

String ExternalEfficiencyMapDefinition::GetResultTypeName ( int index )

Returns an result type name for this efficiency map of external data input by specifying the index.

Parameters

val	Index of the result type

Returns: Result type name

void ExternalEfficiencyMapDefinition::ImportFromMatrixTable ( String & filename )

Specifies a matrix type point sequence from a file in the efficiency map for external data input.

Parameters

filename File name

void ExternalEfficiencyMapDefinition::ImportFromMultiColumnTable ( String & filename )

Specifies multiple result type point sequence from file to efficiency map of external data input.

Parameters

filename File name

bool ExternalEfficiencyMapDefinition::IsValid ( )

virtual

Returns True if an object is valid.

Returns: Whether or not the ExternalEfficiencyMapDefinition object is valid

String ExternalEfficiencyMapDefinition::Name ( )

Returns the result table definition name as a string.

Returns: Efficiency map setting name

int ExternalEfficiencyMapDefinition::NumResultTypes ( )

Returns the number of result types for this efficiency map of external data input.

Returns: Number of result types

void ExternalEfficiencyMapDefinition::SetInputType ( int type )

Specifies the input type for this efficiency map of external data input.

Parameters

type	Input type for the definition

void ExternalEfficiencyMapDefinition::SetMatrixTable ( String array & array )

Specifies a matrix type point sequence in the efficiency map of external data input.

Parameters

array Multidimensional array

void ExternalEfficiencyMapDefinition::SetMultiColumnTable ( String array & array )

Specifies multiple result type point sequence in the efficiency map of external data input.

Parameters

array Multidimensional array

void ExternalEfficiencyMapDefinition::SetName ( String & title )

Specifies the name for this efficiency map of external data input.

Parameters

title Efficiency map setting name

void ExternalEfficiencyMapDefinition::SetResultType	(	int	index,
		String &	resultName,
		bool	loss
	)

Specifies the result type for this efficiency map of external data input.

Parameters

index	Index of the result type
resultName	Result type name
loss	Flag to calculate as loss

Public Member Functions

Detailed Description

Member Function Documentation