ThermalModelDefinition class is used for thermal model domains.
The class can be called from the Study class.
. More...

Public Member Functions
void	ExportCustomCoolantPath (String &filename)
	Exports coolant path to xml file. More...

String	GetCoolantPathType ()
	Returns the cooling path type. More...

String	GetLink ()
	Returns the name of the condition that is linked to the thermal model definition. More...

String	GetLinkWithType (String &type)
	Returns the name of the condition that is linked to the thermal model definition by type. More...

String	GetName ()
	Returns the thermal model definition name as a string. More...

DataSet *	GetTable (String &propName)
	Returns the value of the specified table property. More...

Variant	GetValue (String &propName)
	Returns the value of property. More...

void	ImportCustomCoolantPath (String &filename)
	Import the coolant path from xml file. If an error occurs, the settings will not be changed. More...

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

void	SetCoolantPathType (String &name)
	Set the cooling path type. More...

void	SetDefaultsFromGeometry ()
	Sets default values for thermal model parameters derived from the geometry. Uses geometry values such as stack length and outer diameter to initialise thermal model parameters such as the housing height.

void	SetLink (String &name)
	Specifies a condition to link to the thermal model definition. More...

void	SetLinkWithType (Variant &type, Variant &val)
	Specifies the condition to link to the thermal model definition by type. More...

void	SetName (String &name)
	Specifies the name of this thermal model definition. More...

void	SetTableProperty (String &propName, DataSet *set)
	Specifies a table for the specified properties. More...

void	SetValue (String &propName, Variant &value)
	Specifies the value of the real number property or flag property. More...

Detailed Description

ThermalModelDefinition class is used for thermal model domains.
The class can be called from the Study class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetThermalModelDefinition(0)

Member Function Documentation

void ThermalModelDefinition::ExportCustomCoolantPath ( String & filename )

Exports coolant path to xml file.

Parameters

filename File path

String ThermalModelDefinition::GetCoolantPathType ( )

Returns the cooling path type.

Returns: cooling path type

String ThermalModelDefinition::GetLink ( )

Returns the name of the condition that is linked to the thermal model definition.

Returns: Condition name

String ThermalModelDefinition::GetLinkWithType ( String & type )

Returns the name of the condition that is linked to the thermal model definition by type.

Parameters

type	Type name ReferDriveCycleCondition : Drive cycle condition

Returns: Condition name

String ThermalModelDefinition::GetName ( )

Returns the thermal model definition name as a string.

Returns: Name of the thermal model definition

DataSet * ThermalModelDefinition::GetTable ( String & propName )

Returns the value of the specified table property.

Parameters

propName Property name

Returns: DataSet (table)

Variant ThermalModelDefinition::GetValue ( String & propName )

Returns the value of property.

Parameters

propName Property name

Returns: Property value

void ThermalModelDefinition::ImportCustomCoolantPath ( String & filename )

Import the coolant path from xml file. If an error occurs, the settings will not be changed.

Parameters

filename File path

bool ThermalModelDefinition::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the ThermalModelDefinition object is valid

void ThermalModelDefinition::SetCoolantPathType ( String & name )

Set the cooling path type.

Cooling Jacket
Cooling Jacket + Housing Spray
Cooling Jacket + End Cap Spray
Cooling Jacket + Hollow Shaft
Cooling Jacket + Hollow Shaft Spray
Hollow Shaft
Hollow Shaft + Cooling Jacket
Hollow Shaft Spray
Hollow Shaft + Cooling Jacket + Housing Spray
Hollow Shaft + Cooling Jacket + End Cap Spray
Hollow Shaft + Cooling Jacket + Housing Spray + Rotor Spray
Cooling Jacket + End Cap Spray + Rotor Spray
Custom

Parameters

name	Cooling path type

void ThermalModelDefinition::SetLink ( String & name )

Specifies a condition to link to the thermal model definition.

Parameters

name	Condition name

void ThermalModelDefinition::SetLinkWithType	(	Variant &	type,
		Variant &	val
	)

Specifies the condition to link to the thermal model definition by type.

Parameters

type	Type name ReferDriveCycleCondition : Drive cycle condition
val	Condition name

void ThermalModelDefinition::SetName ( String & name )

Specifies the name of this thermal model definition.

Parameters

name	Name of the thermal model definition

void ThermalModelDefinition::SetTableProperty	(	String &	propName,
		DataSet *	set
	)

Specifies a table for the specified properties.

Parameters

propName	Property name
set	DataSet (table)

void ThermalModelDefinition::SetValue	(	String &	propName,
		Variant &	value
	)

Specifies the value of the real number property or flag property.

The unit that is currently being used is used. A real number value is converted into an integer for the flag property.

Parameters

propName	Property name
value	Property value

Public Member Functions

Detailed Description

Member Function Documentation