OpenTD.HeatLoad Class Reference

Client-side representation of a HeatLoad entity in a TD instance. More...

Public Types
enum	HeatLoadTypes { LOAD , FLUX , VOLUME }
	Specifies the dimension of a heatload. More...
enum	HeatLoadTransientTypes { CONSTANT_HEAT_LOAD , TIME_VARY_HEAT_LOAD , TIME_TEMP_VARY_HEAT_LOAD , TEMP_VARY_HEAT_LOAD }
	Specifies how a heatload behaves in a transient solution. More...
enum	AppliedTypeBoundaryConds {   SURFACE , NODE , SOLID , EDGEABT ,   NOTSPECIFIED , LUMP }
	Specifies what kind of entity a heatload is applied to. More...
enum	DataOrArrayName { DATA = 0 , ARRAY_NAME = 1 }
	Specifies whether to use data stored in a heatload or a specified Sinda array. More...
enum	TimeDependentSteadyStateTypes { TIME_AVERAGE , TIME_INTERP , TIME_AVG_IF_DTIME_NOT_ZERO }
	Specifies how a time-dependent heatload behaves in a steady-state solution. More...

Public Member Functions
override void	Update ()
	Updates the TD entity with the latest client data.
override void	CreateIn (ThermalDesktop td)
	Creates the TD entity in the specified TD instance.
void	CheckData ()
override string	ToString ()
void	SetFrom (TdDbEntityData x)
void	SetFrom (DbObject x)
void	SetFrom (OpenTDObject x)
override void	UpdateFromTD ()
	Updates the client-side instance with the latest data from the TD entity.
override bool	Equals (object obj)
override int	GetHashCode ()
void	UpdateIn (ThermalDesktop td)
	Updates the TD entity corresponding to this object in the specified TD instance, if possible.

Static Public Member Functions
static bool	operator== (DbObject first, DbObject second)
static bool	operator!= (DbObject first, DbObject second)

Protected Member Functions
string	ToString (string Submodel, string Id, string Comment)
string	ToString (string Submodel, int Id, string Comment)

Protected Attributes
ITdCommander	TdProxy

Properties
List< Connection >	ApplyConnections [get, set]
string	Name [get, set]
SubmodelNameData	Submodel [get, set]
double	Value [get, set]
ExpressionData	ValueExp [get, set]
double	TimeVaryMult [get, set]
ExpressionData	TimeVaryMultExp [get, set]
HeatLoadTransientTypes	HeatLoadTransientType [get, set]
DimensionalList< Time >	TimeArray [get, set]
ListSI	ValueArraySI [get, set]
	Note that this array is always in SI units, regardless of WorkingUnits.
double	TimeTempMult [get, set]
ExpressionData	TimeTempMultExp [get, set]
DimensionalList< Time >	TimeTempTimeArray [get, set]
DimensionalList< Temp >	TimeTempTempArray [get, set]
ListSI	TimeTempValueArraySI [get, set]
	Note that this array is always in SI units, regardless of WorkingUnits.
string	TimeTempSindaArrayName [get, set]
DataOrArrayName	TimeTempInputDataOrArrayName [get, set]
UnitsData	TimeTempSindaArrayTimeUnits [get, set]
UnitsData	TimeTempSindaArrayTempUnits [get, set]
UnitsData	TimeTempSindaArrayDataUnits [get, set]
double	TempMult [get, set]
ExpressionData	TempMultExp [get, set]
DimensionalList< Temp >	TempArray [get, set]
ListSI	TempValueArraySI [get, set]
	Note that this array is always in SI units, regardless of WorkingUnits.
string	TempSindaArrayName [get, set]
DataOrArrayName	TempInputDataOrArrayName [get, set]
UnitsData	TempSindaArrayTempUnits [get, set]
UnitsData	TempSindaArrayDataUnits [get, set]
int	UseMLINodes [get, set]
HeatLoadTypes	Type [get, set]
HeatLoadTypes	TimeVaryType [get, set]
HeatLoadTypes	TimeTempVaryType [get, set]
HeatLoadTypes	TempVaryType [get, set]
AppliedTypeBoundaryConds	AppliedType [get, set]
ExpressionData	EnabledExp [get, set]
TimeDependentSteadyStateTypes	TimeDependentSteadyStateType [get, set]
ExpressionArrayClassData	TimeArrayExp [get, set]
ExpressionArrayClassData	ValueArrayExp [get, set]
ExpressionArrayClassData	TimeTempTimeArrayExp [get, set]
ExpressionArrayClassData	TimeTempTempArrayExp [get, set]
ExpressionArrayClassData	TimeTempValueArrayExp [get, set]
ExpressionArrayClassData	TempArrayExp [get, set]
ExpressionArrayClassData	TempValueArrayExp [get, set]
int	TempDependentLoadAverageTempOrPerNode [get, set]
string	TdClassName [get]
string	Layer [get, set]
int	ColorIndex [get, set]
	Specifies a color. See the AutoCAD Layer Properties Manager for valid values.
string	Handle [get, set]
string	TypeName [get, set]

Detailed Description

Member Enumeration Documentation

◆ AppliedTypeBoundaryConds

◆ DataOrArrayName

◆ HeatLoadTransientTypes

◆ HeatLoadTypes

◆ TimeDependentSteadyStateTypes

Member Function Documentation

◆ CheckData()

◆ CreateIn()

◆ Equals()

◆ GetHashCode()

◆ operator!=()

◆ operator==()

◆ SetFrom() [1/3]

◆ SetFrom() [2/3]

◆ SetFrom() [3/3]

◆ ToString() [1/3]

◆ ToString() [2/3]

◆ ToString() [3/3]

◆ Update()

◆ UpdateFromTD()

◆ UpdateIn()

Member Data Documentation

◆ TdProxy

Property Documentation

◆ AppliedType

◆ ApplyConnections

◆ ColorIndex

◆ EnabledExp

◆ Handle

◆ HeatLoadTransientType

◆ Layer

◆ Name

◆ Submodel

◆ TdClassName

◆ TempArray

◆ TempArrayExp

◆ TempDependentLoadAverageTempOrPerNode

◆ TempInputDataOrArrayName

◆ TempMult

◆ TempMultExp

◆ TempSindaArrayDataUnits

◆ TempSindaArrayName

◆ TempSindaArrayTempUnits

◆ TempValueArrayExp

◆ TempValueArraySI

◆ TempVaryType

◆ TimeArray

◆ TimeArrayExp

◆ TimeDependentSteadyStateType

◆ TimeTempInputDataOrArrayName

◆ TimeTempMult

◆ TimeTempMultExp

◆ TimeTempSindaArrayDataUnits

◆ TimeTempSindaArrayName

◆ TimeTempSindaArrayTempUnits

◆ TimeTempSindaArrayTimeUnits

◆ TimeTempTempArray

◆ TimeTempTempArrayExp

◆ TimeTempTimeArray

◆ TimeTempTimeArrayExp

◆ TimeTempValueArrayExp

◆ TimeTempValueArraySI

◆ TimeTempVaryType

◆ TimeVaryMult

◆ TimeVaryMultExp

◆ TimeVaryType

◆ Type

◆ TypeName

◆ UseMLINodes

◆ Value

◆ ValueArrayExp

◆ ValueArraySI

◆ ValueExp

---

The documentation for this class was generated from the following file:

• C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/OpenTD/OpenTD/HeatLoad.cs