ThermalEfficiencyMapDefinition Class Reference

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

Public Member Functions
String	GetCoilTemperatureType ()
	Returns the coil temperature limit setting type. More...
bool	GetLimitCoilTemperature ()
	Returns whether to set an upper limit for the coil temperature. More...
bool	GetLimitMagnetTemperature ()
	Returns whether to set an upper limit for the magnet temperature. More...
String	GetMagnetTemperatureType ()
	Returns the magnet temperature limit setting type. More...
double	GetMaxCoilTemperature ()
	Returns the maximum coil temperature. More...
double	GetMaxMagnetTemperature ()
	Returns the maximum magnet temperature. 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	SetCoilTemperatureType (Variant &type)
	Specifies the type of upper limit setting for the coil temperature. More...
void	SetLimitCoilTemperature (bool value)
	Specifies whether to set an upper limit for the coil temperature. More...
void	SetLimitMagnetTemperature (bool value)
	Specifies whether to set an upper limit for the magnet temperature. More...
void	SetMagnetTemperatureType (Variant &type)
	Specifies the type of upper limit setting for the magnet temperature. More...
void	SetMaxCoilTemperature (Variant &value)
	Specifies the maximum temperature of the coil. More...
void	SetMaxMagnetTemperature (Variant &value)
	Specifies the maximum temperature of the magnet. More...
void	SetName (String &title)
	Specifies the name for this efficency map definition. More...

Detailed Description

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

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetThermalEfficiencyMapDefinition(0)

Member Function Documentation

String ThermalEfficiencyMapDefinition::GetCoilTemperatureType

(

)

Returns the coil temperature limit setting type.

peak
average

Returns

Limit type as a string

bool ThermalEfficiencyMapDefinition::GetLimitCoilTemperature

(

)

Returns whether to set an upper limit for the coil temperature.

Returns

Flag to coil temperature limit

bool ThermalEfficiencyMapDefinition::GetLimitMagnetTemperature

(

)

Returns whether to set an upper limit for the magnet temperature.

Returns

Flag to magnet temperature limit

String ThermalEfficiencyMapDefinition::GetMagnetTemperatureType

(

)

Returns the magnet temperature limit setting type.

peak
average

Returns

Limit type as a string

double ThermalEfficiencyMapDefinition::GetMaxCoilTemperature

(

)

Returns the maximum coil temperature.

Returns

Maximum temperature.

double ThermalEfficiencyMapDefinition::GetMaxMagnetTemperature

(

)

Returns the maximum magnet temperature.

Returns

Maximum temperature.

bool ThermalEfficiencyMapDefinition::IsValid ( )

virtual

Returns True if an object is valid.

Returns

Whether or not the ThermalEfficiencyMapDefinition object is valid

String ThermalEfficiencyMapDefinition::Name

(

)

Returns the result table definition name as a string.

Returns

Name or the definition

void ThermalEfficiencyMapDefinition::SetCoilTemperatureType

(

Variant &

type

)

Specifies the type of upper limit setting for the coil temperature.

Parameters

type	Temperature limit type

void ThermalEfficiencyMapDefinition::SetLimitCoilTemperature

(

bool

value

)

Specifies whether to set an upper limit for the coil temperature.

Parameters

value

Flag to coil temperature limit

void ThermalEfficiencyMapDefinition::SetLimitMagnetTemperature

(

bool

value

)

Specifies whether to set an upper limit for the magnet temperature.

Parameters

value

Flag to magnet temperature limit

void ThermalEfficiencyMapDefinition::SetMagnetTemperatureType

(

Variant &

type

)

Specifies the type of upper limit setting for the magnet temperature.

Parameters

type	Temperature limit type

void ThermalEfficiencyMapDefinition::SetMaxCoilTemperature

(

Variant &

value

)

Specifies the maximum temperature of the coil.

Parameters

value

Maximum Temperature

void ThermalEfficiencyMapDefinition::SetMaxMagnetTemperature

(

Variant &

value

)

Specifies the maximum temperature of the magnet.

Parameters

value

Maximum Temperature

void ThermalEfficiencyMapDefinition::SetName

(

String &

title

)

Specifies the name for this efficency map definition.

Parameters

title

Name for the definition.