DifferenceEfficiencyMapDefinition class is used to specify the settings for an difference efficiency map.
The class can be called from the Study class.
. More...

Public Member Functions
void	ClearRelationTable ()
	Clears the result type association in the differential efficiency map.

int	GetBaseCaseIndex ()
	Returns the case index of the comparison target 1 of the differential efficiency map. More...

EfficiencyMapDefinition *	GetBaseEfficiencyMap ()
	Returns the comparison target 1 efficiency map of the differential efficiency map. More...

ExternalEfficiencyMapDefinition *	GetBaseExternalEfficiencyMap ()
	Returns the map of the external data input of the comparison target 1 of the differential efficiency map. More...

int	GetCalculationType ()
	Returns the calculation type of the differential efficiency map. More...

int	GetOtherCaseIndex ()
	Returns the case index of the comparison target 2 of the differential efficiency map. More...

EfficiencyMapDefinition *	GetOtherEfficiencyMap ()
	Returns the comparison target 2 efficiency map of the differential efficiency map. More...

ExternalEfficiencyMapDefinition *	GetOtherExternalEfficiencyMap ()
	Returns the map of the external data input of the comparison target 2 of the differential efficiency map. More...

Study *	GetOtherStudy ()
	Returns the study of the comparison target 2 of the differential efficiency map. More...

bool	GetOutlineOverlap ()
	Returns the flag of whether to draw the part where the outline lines of the differential efficiency map do not overlap. More...

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

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

void	SetBaseCaseIndex (int caseIndex)
	Specifies the case index of the comparison target 1 of the differential efficiency map. More...

void	SetBaseEfficiencyMap (EfficiencyMapDefinition *def)
	Specifies the comparison target 1 efficiency map of the differential efficiency map. More...

void	SetBaseExternalEfficiencyMap (ExternalEfficiencyMapDefinition *def)
	Specifies the map of the external data input of the comparison target 1 of the differential efficiency map. More...

void	SetCalculationType (int type)
	Specifies the calculation type of the differential efficiency map. More...

void	SetName (String &title)
	Specifies the name for this difference efficiency map. More...

void	SetOtherCaseIndex (int caseIndex)
	Specifies the case index of the comparison target 2 of the differential efficiency map. More...

void	SetOtherEfficiencyMap (EfficiencyMapDefinition *def)
	Specifies the comparison target 2 efficiency map of the differential efficiency map. More...

void	SetOtherExternalEfficiencyMap (ExternalEfficiencyMapDefinition *def)
	Returns the map of the external data input of the comparison target 2 of the differential efficiency map. More...

void	SetOtherStudy (Study *study)
	Specifies the study of the comparison target 2 of the differential efficiency map. More...

void	SetOutlineOverlap (bool overlap)
	Specifies whether to draw the part where the outline lines of the difference efficiency map do not overlap. More...

void	SetRelationTable (String array &array)
	Specifies the result type association for the differential efficiency map. More...

Detailed Description

DifferenceEfficiencyMapDefinition class is used to specify the settings for an difference efficiency map.
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetDifferenceEfficiencyMapDefinition(0)

Member Function Documentation

int DifferenceEfficiencyMapDefinition::GetBaseCaseIndex ( )

Returns the case index of the comparison target 1 of the differential efficiency map.

Returns: Case index

The returned Case ID is numbered from zero.

EfficiencyMapDefinition * DifferenceEfficiencyMapDefinition::GetBaseEfficiencyMap ( )

Returns the comparison target 1 efficiency map of the differential efficiency map.

Returns: Map of comparison object 1

ExternalEfficiencyMapDefinition * DifferenceEfficiencyMapDefinition::GetBaseExternalEfficiencyMap ( )

Returns the map of the external data input of the comparison target 1 of the differential efficiency map.

Returns: Map of comparison object 1

int DifferenceEfficiencyMapDefinition::GetCalculationType ( )

Returns the calculation type of the differential efficiency map.

Returns: Calculation type

int DifferenceEfficiencyMapDefinition::GetOtherCaseIndex ( )

Returns the case index of the comparison target 2 of the differential efficiency map.

Returns: Case index

The returned Case ID is numbered from zero.

EfficiencyMapDefinition * DifferenceEfficiencyMapDefinition::GetOtherEfficiencyMap ( )

Returns the comparison target 2 efficiency map of the differential efficiency map.

Returns: Map of comparison object 2

ExternalEfficiencyMapDefinition * DifferenceEfficiencyMapDefinition::GetOtherExternalEfficiencyMap ( )

Returns the map of the external data input of the comparison target 2 of the differential efficiency map.

Returns: Map of comparison object 2

Study * DifferenceEfficiencyMapDefinition::GetOtherStudy ( )

Returns the study of the comparison target 2 of the differential efficiency map.

Returns: Study of the comparison target 2

bool DifferenceEfficiencyMapDefinition::GetOutlineOverlap ( )

Returns the flag of whether to draw the part where the outline lines of the differential efficiency map do not overlap.

Returns: Flag that does not draw parts where outline lines do not overlap.

bool DifferenceEfficiencyMapDefinition::IsValid ( )

virtual

Returns True if an object is valid.

Returns: Whether or not the DifferenceEfficiencyMapDefinition object is valid

String DifferenceEfficiencyMapDefinition::Name ( )

Returns the result table definition name as a string.

Returns: Efficiency map setting name

void DifferenceEfficiencyMapDefinition::SetBaseCaseIndex ( int caseIndex )

Specifies the case index of the comparison target 1 of the differential efficiency map.

Parameters

caseIndex Case index

The caseIndex is numbered from 0.

void DifferenceEfficiencyMapDefinition::SetBaseEfficiencyMap ( EfficiencyMapDefinition * def )

Specifies the comparison target 1 efficiency map of the differential efficiency map.

Parameters

def	Map of comparison object 1

void DifferenceEfficiencyMapDefinition::SetBaseExternalEfficiencyMap ( ExternalEfficiencyMapDefinition * def )

Specifies the map of the external data input of the comparison target 1 of the differential efficiency map.

Parameters

def	Map of comparison object 1

void DifferenceEfficiencyMapDefinition::SetCalculationType ( int type )

Specifies the calculation type of the differential efficiency map.

Parameters

type	Calculation type

void DifferenceEfficiencyMapDefinition::SetName ( String & title )

Specifies the name for this difference efficiency map.

Parameters

title Efficiency map setting name

void DifferenceEfficiencyMapDefinition::SetOtherCaseIndex ( int caseIndex )

Specifies the case index of the comparison target 2 of the differential efficiency map.

Parameters

caseIndex Case index

The caseIndex is numbered from 0.

void DifferenceEfficiencyMapDefinition::SetOtherEfficiencyMap ( EfficiencyMapDefinition * def )

Specifies the comparison target 2 efficiency map of the differential efficiency map.

Parameters

def	Map of comparison object 2

void DifferenceEfficiencyMapDefinition::SetOtherExternalEfficiencyMap ( ExternalEfficiencyMapDefinition * def )

Returns the map of the external data input of the comparison target 2 of the differential efficiency map.

Parameters

def	Map of comparison object 2

void DifferenceEfficiencyMapDefinition::SetOtherStudy ( Study * study )

Specifies the study of the comparison target 2 of the differential efficiency map.

Parameters

study Study of the comparison target 2

void DifferenceEfficiencyMapDefinition::SetOutlineOverlap ( bool overlap )

Specifies whether to draw the part where the outline lines of the difference efficiency map do not overlap.

Parameters

overlap Flag that does not draw parts where outline lines do not overlap.

void DifferenceEfficiencyMapDefinition::SetRelationTable ( String array & array )

Specifies the result type association for the differential efficiency map.

Parameters

array Result type list (multidimensional array)

Public Member Functions

Detailed Description

Member Function Documentation