Skip to main content

OpenTD .NET8 reference 2025 R2

OpenTD.RcHeatLoadData Class Reference

Last update: 16.07.2025

<exclude > More...

Inheritance diagram for OpenTD.RcHeatLoadData:
OpenTD.TdDbEntityDataOpenTD.ITdDerivedOpenTD.DbObjectOpenTD.ITdDerivedOpenTD.OpenTDObjectOpenTD.IUpdatableOpenTD.IReassignableOpenTD.HeatLoad

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

 RcHeatLoadData ()
 
void CheckData ()
 
override string ToString ()
 
void SetFrom (TdDbEntityData x)
 
void SetFrom (DbObject x)
 
void SetFrom (OpenTDObject x)
 
override void Update ()
 Updates the TD entity with the latest client data.
 
override void UpdateFromTD ()
 Updates the client-side instance with the latest data from the TD entity.
 
override void CreateIn (ThermalDesktop td)
 Creates the TD entity in the specified TD instance.
 
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< ConnectionApplyConnections [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< TimeTimeArray [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< TimeTimeTempTimeArray [get, set]
 
DimensionalList< TempTimeTempTempArray [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< TempTempArray [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 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]
 
string TdClassName [get]
 

Detailed Description

<exclude >

Member Enumeration Documentation

◆ AppliedTypeBoundaryConds

Specifies what kind of entity a heatload is applied to.

Enumerator
SURFACE 
NODE 
SOLID 
EDGEABT 
NOTSPECIFIED 
LUMP 

◆ DataOrArrayName

Specifies whether to use data stored in a heatload or a specified Sinda array.

Enumerator
DATA 
ARRAY_NAME 

◆ HeatLoadTransientTypes

Specifies how a heatload behaves in a transient solution.

Enumerator
CONSTANT_HEAT_LOAD 
TIME_VARY_HEAT_LOAD 
TIME_TEMP_VARY_HEAT_LOAD 
TEMP_VARY_HEAT_LOAD 

◆ HeatLoadTypes

Specifies the dimension of a heatload.

Enumerator
LOAD 
FLUX 
VOLUME 

◆ TimeDependentSteadyStateTypes

Specifies how a time-dependent heatload behaves in a steady-state solution.

Enumerator
TIME_AVERAGE 
TIME_INTERP 
TIME_AVG_IF_DTIME_NOT_ZERO 

Constructor & Destructor Documentation

◆ RcHeatLoadData()

OpenTD.RcHeatLoadData.RcHeatLoadData ( )
inline

Member Function Documentation

◆ CheckData()

void OpenTD.RcHeatLoadData.CheckData ( )
inline

◆ CreateIn()

override void OpenTD.DbObject.CreateIn ( ThermalDesktop td)
inlineinherited

Creates the TD entity in the specified TD instance.

Implements OpenTD.IReassignable.

◆ Equals()

override bool OpenTD.DbObject.Equals ( object obj)
inlineinherited

◆ GetHashCode()

override int OpenTD.DbObject.GetHashCode ( )
inlineinherited

◆ operator!=()

static bool OpenTD.DbObject.operator!= ( DbObject first,
DbObject second )
inlinestaticinherited

◆ operator==()

static bool OpenTD.DbObject.operator== ( DbObject first,
DbObject second )
inlinestaticinherited

◆ SetFrom() [1/3]

void OpenTD.DbObject.SetFrom ( DbObject x)
inlineinherited

◆ SetFrom() [2/3]

void OpenTD.OpenTDObject.SetFrom ( OpenTDObject x)
inlineinherited

◆ SetFrom() [3/3]

void OpenTD.TdDbEntityData.SetFrom ( TdDbEntityData x)
inlineinherited

◆ ToString() [1/3]

override string OpenTD.RcHeatLoadData.ToString ( )
inline

◆ ToString() [2/3]

string OpenTD.TdDbEntityData.ToString ( string Submodel,
int Id,
string Comment )
inlineprotectedinherited

◆ ToString() [3/3]

string OpenTD.TdDbEntityData.ToString ( string Submodel,
string Id,
string Comment )
inlineprotectedinherited

◆ Update()

override void OpenTD.DbObject.Update ( )
inlineinherited

Updates the TD entity with the latest client data.

Implements OpenTD.IUpdatable.

◆ UpdateFromTD()

override void OpenTD.DbObject.UpdateFromTD ( )
inlineinherited

Updates the client-side instance with the latest data from the TD entity.

Implements OpenTD.IUpdatable.

◆ UpdateIn()

void OpenTD.OpenTDObject.UpdateIn ( ThermalDesktop td)
inlineinherited

Updates the TD entity corresponding to this object in the specified TD instance, if possible.

Implements OpenTD.IReassignable.

Member Data Documentation

◆ TdProxy

ITdCommander OpenTD.OpenTDObject.TdProxy
protectedinherited

Property Documentation

◆ AppliedType

AppliedTypeBoundaryConds OpenTD.RcHeatLoadData.AppliedType
getset

◆ ApplyConnections

List<Connection> OpenTD.RcHeatLoadData.ApplyConnections
getset

◆ ColorIndex

int OpenTD.TdDbEntityData.ColorIndex
getsetinherited

Specifies a color. See the AutoCAD Layer Properties Manager for valid values.

◆ EnabledExp

ExpressionData OpenTD.RcHeatLoadData.EnabledExp
getset

◆ Handle

string OpenTD.DbObject.Handle
getsetinherited

◆ HeatLoadTransientType

HeatLoadTransientTypes OpenTD.RcHeatLoadData.HeatLoadTransientType
getset

◆ Layer

string OpenTD.TdDbEntityData.Layer
getsetinherited

◆ Name

string OpenTD.RcHeatLoadData.Name
getset

◆ Submodel

SubmodelNameData OpenTD.RcHeatLoadData.Submodel
getset

◆ TdClassName

string OpenTD.ITdDerived.TdClassName
getinherited

◆ TempArray

DimensionalList<Temp> OpenTD.RcHeatLoadData.TempArray
getset

◆ TempArrayExp

ExpressionArrayClassData OpenTD.RcHeatLoadData.TempArrayExp
getset

◆ TempDependentLoadAverageTempOrPerNode

int OpenTD.RcHeatLoadData.TempDependentLoadAverageTempOrPerNode
getset

◆ TempInputDataOrArrayName

DataOrArrayName OpenTD.RcHeatLoadData.TempInputDataOrArrayName
getset

◆ TempMult

double OpenTD.RcHeatLoadData.TempMult
getset

◆ TempMultExp

ExpressionData OpenTD.RcHeatLoadData.TempMultExp
getset

◆ TempSindaArrayDataUnits

UnitsData OpenTD.RcHeatLoadData.TempSindaArrayDataUnits
getset

◆ TempSindaArrayName

string OpenTD.RcHeatLoadData.TempSindaArrayName
getset

◆ TempSindaArrayTempUnits

UnitsData OpenTD.RcHeatLoadData.TempSindaArrayTempUnits
getset

◆ TempValueArrayExp

ExpressionArrayClassData OpenTD.RcHeatLoadData.TempValueArrayExp
getset

◆ TempValueArraySI

ListSI OpenTD.RcHeatLoadData.TempValueArraySI
getset

Note that this array is always in SI units, regardless of WorkingUnits.

◆ TempVaryType

HeatLoadTypes OpenTD.RcHeatLoadData.TempVaryType
getset

◆ TimeArray

DimensionalList<Time> OpenTD.RcHeatLoadData.TimeArray
getset

◆ TimeArrayExp

ExpressionArrayClassData OpenTD.RcHeatLoadData.TimeArrayExp
getset

◆ TimeDependentSteadyStateType

TimeDependentSteadyStateTypes OpenTD.RcHeatLoadData.TimeDependentSteadyStateType
getset

◆ TimeTempInputDataOrArrayName

DataOrArrayName OpenTD.RcHeatLoadData.TimeTempInputDataOrArrayName
getset

◆ TimeTempMult

double OpenTD.RcHeatLoadData.TimeTempMult
getset

◆ TimeTempMultExp

ExpressionData OpenTD.RcHeatLoadData.TimeTempMultExp
getset

◆ TimeTempSindaArrayDataUnits

UnitsData OpenTD.RcHeatLoadData.TimeTempSindaArrayDataUnits
getset

◆ TimeTempSindaArrayName

string OpenTD.RcHeatLoadData.TimeTempSindaArrayName
getset

◆ TimeTempSindaArrayTempUnits

UnitsData OpenTD.RcHeatLoadData.TimeTempSindaArrayTempUnits
getset

◆ TimeTempSindaArrayTimeUnits

UnitsData OpenTD.RcHeatLoadData.TimeTempSindaArrayTimeUnits
getset

◆ TimeTempTempArray

DimensionalList<Temp> OpenTD.RcHeatLoadData.TimeTempTempArray
getset

◆ TimeTempTempArrayExp

ExpressionArrayClassData OpenTD.RcHeatLoadData.TimeTempTempArrayExp
getset

◆ TimeTempTimeArray

DimensionalList<Time> OpenTD.RcHeatLoadData.TimeTempTimeArray
getset

◆ TimeTempTimeArrayExp

ExpressionArrayClassData OpenTD.RcHeatLoadData.TimeTempTimeArrayExp
getset

◆ TimeTempValueArrayExp

ExpressionArrayClassData OpenTD.RcHeatLoadData.TimeTempValueArrayExp
getset

◆ TimeTempValueArraySI

ListSI OpenTD.RcHeatLoadData.TimeTempValueArraySI
getset

Note that this array is always in SI units, regardless of WorkingUnits.

◆ TimeTempVaryType

HeatLoadTypes OpenTD.RcHeatLoadData.TimeTempVaryType
getset

◆ TimeVaryMult

double OpenTD.RcHeatLoadData.TimeVaryMult
getset

◆ TimeVaryMultExp

ExpressionData OpenTD.RcHeatLoadData.TimeVaryMultExp
getset

◆ TimeVaryType

HeatLoadTypes OpenTD.RcHeatLoadData.TimeVaryType
getset

◆ Type

HeatLoadTypes OpenTD.RcHeatLoadData.Type
getset

◆ TypeName

string OpenTD.DbObject.TypeName
getsetinherited

◆ UseMLINodes

int OpenTD.RcHeatLoadData.UseMLINodes
getset

◆ Value

double OpenTD.RcHeatLoadData.Value
getset

◆ ValueArrayExp

ExpressionArrayClassData OpenTD.RcHeatLoadData.ValueArrayExp
getset

◆ ValueArraySI

ListSI OpenTD.RcHeatLoadData.ValueArraySI
getset

Note that this array is always in SI units, regardless of WorkingUnits.

◆ ValueExp

ExpressionData OpenTD.RcHeatLoadData.ValueExp
getset

The documentation for this class was generated from the following file:
  • C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/OpenTD/OpenTD/HeatLoad.cs

Connect with Ansys