Skip to main content

OpenTD .NET8 reference 2025 R2

OpenTD.Heater Class Reference

Last update: 16.07.2025

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

Inheritance diagram for OpenTD.Heater:
OpenTD.RcHeaterDataOpenTD.TdDbEntityDataOpenTD.ITdDerivedOpenTD.DbObjectOpenTD.ITdDerivedOpenTD.OpenTDObjectOpenTD.IUpdatableOpenTD.IReassignable

Public Types

enum  HeaterSteadyStateOptions { SS_CONSTANT_TEMP , SS_CONSTANT_POWER , SS_PROPORTIONAL , SS_CONSTANT_TEMP_APPLIED_NODES }
 Specifies how heater works for steady-state solutions. More...
 
enum  AppliedTypeBoundaryCond {
  SURFACE , NODE , SOLID , EDGEABT ,
  NOTSPECIFIED , LUMP
}
 What type of entity a heater is applied to. More...
 
enum  LoadTypes { POWER = 0 , FLUX = 1 }
 Different ways to specify heat loads. 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.
 
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< ConnectionApplyConnections [get, set]
 
List< ConnectionSensorConnections [get, set]
 
string Name [get, set]
 
SubmodelNameData Submodel [get, set]
 
double Value [get, set]
 
ExpressionData ValueExp [get, set]
 
Dimensional< TempOnTemp [get, set]
 
ExpressionData OnTempExp [get, set]
 
Dimensional< TempOffTemp [get, set]
 
ExpressionData OffTempExp [get, set]
 
double SSPowerPer [get, set]
 
ExpressionData SSPowerPerExp [get, set]
 
HeaterSteadyStateOptions SSMethod [get, set]
 
ExpressionData SSMethodExp [get, set]
 
Dimensional< TempAbsSSMidPointTempOffset [get, set]
 
ExpressionData SSMidPointTempOffsetExp [get, set]
 
int UseMLINodes [get, set]
 
int UseTransientScaling [get, set]
 
DimensionalList< TimeTimes [get, set]
 
List< double > Scales [get, set]
 
double SSProportionalDamp [get, set]
 
ExpressionData SSProportionalDampExp [get, set]
 
RcHeaterSenseData TransientSenseAttributes [get, set]
 
RcHeaterSenseData SteadyStateSenseAttributes [get, set]
 
ExpressionData EnabledExp [get, set]
 
string RegisterDesignator [get, set]
 
int Proportional [get, set]
 
ExpressionData ProportionalExp [get, set]
 
LoadTypes PowerOrFlux [get, set]
 
int ApplyProportionalStep [get, set]
 
int ProportionalSteps [get, set]
 
ExpressionData ProportionalStepsExp [get, set]
 
AppliedTypeBoundaryCond AppliedTypeLoad [get, set]
 
AppliedTypeBoundaryCond AppliedTypeSense [get, set]
 
string PreLogic [get, set]
 
string PostLogic [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

Client-side representation of a Heater entity in a TD instance.

See also
OpenTD.ThermalDesktop

Member Enumeration Documentation

◆ AppliedTypeBoundaryCond

What type of entity a heater is applied to.

Enumerator
SURFACE 
NODE 
SOLID 
EDGEABT 
NOTSPECIFIED 
LUMP 

◆ HeaterSteadyStateOptions

Specifies how heater works for steady-state solutions.

Enumerator
SS_CONSTANT_TEMP 
SS_CONSTANT_POWER 
SS_PROPORTIONAL 
SS_CONSTANT_TEMP_APPLIED_NODES 

◆ LoadTypes

Different ways to specify heat loads.

Enumerator
POWER 
FLUX 

Member Function Documentation

◆ CreateIn()

override void OpenTD.Heater.CreateIn ( ThermalDesktop td)
inline

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.RcHeaterData.ToString ( )
inlineinherited

◆ 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.Heater.Update ( )
inline

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

◆ AppliedTypeLoad

AppliedTypeBoundaryCond OpenTD.RcHeaterData.AppliedTypeLoad
getsetinherited

◆ AppliedTypeSense

AppliedTypeBoundaryCond OpenTD.RcHeaterData.AppliedTypeSense
getsetinherited

◆ ApplyConnections

List<Connection> OpenTD.RcHeaterData.ApplyConnections
getsetinherited

◆ ApplyProportionalStep

int OpenTD.RcHeaterData.ApplyProportionalStep
getsetinherited

◆ ColorIndex

int OpenTD.TdDbEntityData.ColorIndex
getsetinherited

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

◆ EnabledExp

ExpressionData OpenTD.RcHeaterData.EnabledExp
getsetinherited

◆ Handle

string OpenTD.DbObject.Handle
getsetinherited

◆ Layer

string OpenTD.TdDbEntityData.Layer
getsetinherited

◆ Name

string OpenTD.RcHeaterData.Name
getsetinherited

◆ OffTemp

Dimensional<Temp> OpenTD.RcHeaterData.OffTemp
getsetinherited

◆ OffTempExp

ExpressionData OpenTD.RcHeaterData.OffTempExp
getsetinherited

◆ OnTemp

Dimensional<Temp> OpenTD.RcHeaterData.OnTemp
getsetinherited

◆ OnTempExp

ExpressionData OpenTD.RcHeaterData.OnTempExp
getsetinherited

◆ PostLogic

string OpenTD.RcHeaterData.PostLogic
getsetinherited

◆ PowerOrFlux

LoadTypes OpenTD.RcHeaterData.PowerOrFlux
getsetinherited

◆ PreLogic

string OpenTD.RcHeaterData.PreLogic
getsetinherited

◆ Proportional

int OpenTD.RcHeaterData.Proportional
getsetinherited

◆ ProportionalExp

ExpressionData OpenTD.RcHeaterData.ProportionalExp
getsetinherited

◆ ProportionalSteps

int OpenTD.RcHeaterData.ProportionalSteps
getsetinherited

◆ ProportionalStepsExp

ExpressionData OpenTD.RcHeaterData.ProportionalStepsExp
getsetinherited

◆ RegisterDesignator

string OpenTD.RcHeaterData.RegisterDesignator
getsetinherited

◆ Scales

List<double> OpenTD.RcHeaterData.Scales
getsetinherited

◆ SensorConnections

List<Connection> OpenTD.RcHeaterData.SensorConnections
getsetinherited

◆ SSMethod

HeaterSteadyStateOptions OpenTD.RcHeaterData.SSMethod
getsetinherited

◆ SSMethodExp

ExpressionData OpenTD.RcHeaterData.SSMethodExp
getsetinherited

◆ SSMidPointTempOffset

Dimensional<TempAbs> OpenTD.RcHeaterData.SSMidPointTempOffset
getsetinherited

◆ SSMidPointTempOffsetExp

ExpressionData OpenTD.RcHeaterData.SSMidPointTempOffsetExp
getsetinherited

◆ SSPowerPer

double OpenTD.RcHeaterData.SSPowerPer
getsetinherited

◆ SSPowerPerExp

ExpressionData OpenTD.RcHeaterData.SSPowerPerExp
getsetinherited

◆ SSProportionalDamp

double OpenTD.RcHeaterData.SSProportionalDamp
getsetinherited

◆ SSProportionalDampExp

ExpressionData OpenTD.RcHeaterData.SSProportionalDampExp
getsetinherited

◆ SteadyStateSenseAttributes

RcHeaterSenseData OpenTD.RcHeaterData.SteadyStateSenseAttributes
getsetinherited

◆ Submodel

SubmodelNameData OpenTD.RcHeaterData.Submodel
getsetinherited

◆ TdClassName

string OpenTD.ITdDerived.TdClassName
getinherited

◆ Times

DimensionalList<Time> OpenTD.RcHeaterData.Times
getsetinherited

◆ TransientSenseAttributes

RcHeaterSenseData OpenTD.RcHeaterData.TransientSenseAttributes
getsetinherited

◆ TypeName

string OpenTD.DbObject.TypeName
getsetinherited

◆ UseMLINodes

int OpenTD.RcHeaterData.UseMLINodes
getsetinherited

◆ UseTransientScaling

int OpenTD.RcHeaterData.UseTransientScaling
getsetinherited

◆ Value

double OpenTD.RcHeaterData.Value
getsetinherited

◆ ValueExp

ExpressionData OpenTD.RcHeaterData.ValueExp
getsetinherited

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

Connect with Ansys