Skip to main content

OpenTD .NET8 reference 2025 R2

OpenTD.PID Class Reference

Last update: 16.07.2025

Client-side representation of a Logic Object PID in a TD instance. More...

Inheritance diagram for OpenTD.PID:
OpenTD.RcPIDDataOpenTD.LogicObjectOpenTD.ITdDerivedOpenTD.OpenTDObjectOpenTD.ITdDerivedOpenTD.IUpdatableOpenTD.IReassignable

Public Types

enum  InputType2 { REGISTER2 , USER2 }
 PID input variable type. More...
 
enum  LogicType {
  TRANSLATECODE = -1 , ARRAY_INTERP , BIVAR_INTERP , PID ,
  USERCODE , DIFFEQ , DIFFEQANGULAR , DIFFEQRPM ,
  COMPAREDL , USER_ARRAY , SUBCOMPLQ , FORTRANARRAY ,
  MAXLOGICTYPE
}
 TD Logic Object types. 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 void UpdateFromTD ()
 Updates the client-side instance with the latest data from the TD entity.
 
override string ToString ()
 
void SetFrom (OpenTDObject x)
 
void UpdateIn (ThermalDesktop td)
 Updates the TD entity corresponding to this object in the specified TD instance, if possible.
 

Protected Attributes

ITdCommander TdProxy
 

Properties

InputType2 InputType = InputType2.REGISTER2 [get, set]
 
InputType2 InputYType = InputType2.REGISTER2 [get, set]
 
string InputSymbol = string.Empty [get, set]
 
string InputYSymbol = string.Empty [get, set]
 
string OutputSymbol = string.Empty [get, set]
 
string User = string.Empty [get, set]
 
string UserY = string.Empty [get, set]
 
UnitsData.UnitsType XUnits = UnitsData.UnitsType.DIMENSIONLESS [get, set]
 
UnitsData.UnitsType YUnits = UnitsData.UnitsType.DIMENSIONLESS [get, set]
 
UnitsData.UnitsType DataUnits = UnitsData.UnitsType.DIMENSIONLESS [get, set]
 
int RoutineType = 0 [get, set]
 
double GP [get, set]
 
ExpressionData GPExpression = new ExpressionData() [get, set]
 
double GI [get, set]
 
ExpressionData GIExpression = new ExpressionData() [get, set]
 
double GD [get, set]
 
ExpressionData GDExpression = new ExpressionData() [get, set]
 
double DT [get, set]
 
ExpressionData DTExpression = new ExpressionData() [get, set]
 
double DTSS [get, set]
 
ExpressionData DTSSExpression = new ExpressionData() [get, set]
 
bool Discrete = false [get, set]
 
bool SteadyState = true [get, set]
 
bool Transient = true [get, set]
 
bool Windup = false [get, set]
 
bool CVLimit = false [get, set]
 
int PIDInt = 0 [get, set]
 
double CVMin = -1e30 [get, set]
 
ExpressionData CVMinExpression = new ExpressionData() [get, set]
 
double CVMax = 1e30 [get, set]
 
ExpressionData CVMaxExpression = new ExpressionData() [get, set]
 
string TdClassName [get]
 
string Handle [get, set]
 
string Comment [get, set]
 
SubmodelNameData Submodel [get, set]
 
ExpressionData EnabledExp [get, set]
 
string GroupName [get, set]
 
LogicType Type [get]
 

Detailed Description

Client-side representation of a Logic Object PID in a TD instance.

See also
OpenTD.ThermalDesktop

Member Enumeration Documentation

◆ InputType2

PID input variable type.

Enumerator
REGISTER2 
USER2 

◆ LogicType

TD Logic Object types.

Enumerator
TRANSLATECODE 
ARRAY_INTERP 
BIVAR_INTERP 
PID 
USERCODE 
DIFFEQ 
DIFFEQANGULAR 
DIFFEQRPM 
COMPAREDL 
USER_ARRAY 
SUBCOMPLQ 
FORTRANARRAY 
MAXLOGICTYPE 

Member Function Documentation

◆ CreateIn()

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

Creates the TD entity in the specified TD instance.

Implements OpenTD.IReassignable.

◆ SetFrom()

void OpenTD.OpenTDObject.SetFrom ( OpenTDObject x)
inlineinherited

◆ ToString()

override string OpenTD.LogicObject.ToString ( )
inlineinherited

◆ Update()

override void OpenTD.PID.Update ( )
inline

Updates the TD entity with the latest client data.

Implements OpenTD.IUpdatable.

◆ UpdateFromTD()

override void OpenTD.LogicObject.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

◆ Comment

string OpenTD.LogicObject.Comment
getsetinherited

◆ CVLimit

bool OpenTD.RcPIDData.CVLimit = false
getsetinherited

◆ CVMax

double OpenTD.RcPIDData.CVMax = 1e30
getsetinherited

◆ CVMaxExpression

ExpressionData OpenTD.RcPIDData.CVMaxExpression = new ExpressionData()
getsetinherited

◆ CVMin

double OpenTD.RcPIDData.CVMin = -1e30
getsetinherited

◆ CVMinExpression

ExpressionData OpenTD.RcPIDData.CVMinExpression = new ExpressionData()
getsetinherited

◆ DataUnits

UnitsData.UnitsType OpenTD.RcPIDData.DataUnits = UnitsData.UnitsType.DIMENSIONLESS
getsetinherited

◆ Discrete

bool OpenTD.RcPIDData.Discrete = false
getsetinherited

◆ DT

double OpenTD.RcPIDData.DT
getsetinherited

◆ DTExpression

ExpressionData OpenTD.RcPIDData.DTExpression = new ExpressionData()
getsetinherited

◆ DTSS

double OpenTD.RcPIDData.DTSS
getsetinherited

◆ DTSSExpression

ExpressionData OpenTD.RcPIDData.DTSSExpression = new ExpressionData()
getsetinherited

◆ EnabledExp

ExpressionData OpenTD.LogicObject.EnabledExp
getsetinherited

◆ GD

double OpenTD.RcPIDData.GD
getsetinherited

◆ GDExpression

ExpressionData OpenTD.RcPIDData.GDExpression = new ExpressionData()
getsetinherited

◆ GI

double OpenTD.RcPIDData.GI
getsetinherited

◆ GIExpression

ExpressionData OpenTD.RcPIDData.GIExpression = new ExpressionData()
getsetinherited

◆ GP

double OpenTD.RcPIDData.GP
getsetinherited

◆ GPExpression

ExpressionData OpenTD.RcPIDData.GPExpression = new ExpressionData()
getsetinherited

◆ GroupName

string OpenTD.LogicObject.GroupName
getsetinherited

◆ Handle

string OpenTD.LogicObject.Handle
getsetinherited

◆ InputSymbol

string OpenTD.RcPIDData.InputSymbol = string.Empty
getsetinherited

◆ InputType

InputType2 OpenTD.RcPIDData.InputType = InputType2.REGISTER2
getsetinherited

◆ InputYSymbol

string OpenTD.RcPIDData.InputYSymbol = string.Empty
getsetinherited

◆ InputYType

InputType2 OpenTD.RcPIDData.InputYType = InputType2.REGISTER2
getsetinherited

◆ OutputSymbol

string OpenTD.RcPIDData.OutputSymbol = string.Empty
getsetinherited

◆ PIDInt

int OpenTD.RcPIDData.PIDInt = 0
getsetinherited

◆ RoutineType

int OpenTD.RcPIDData.RoutineType = 0
getsetinherited

◆ SteadyState

bool OpenTD.RcPIDData.SteadyState = true
getsetinherited

◆ Submodel

SubmodelNameData OpenTD.LogicObject.Submodel
getsetinherited

◆ TdClassName

string OpenTD.ITdDerived.TdClassName
getinherited

◆ Transient

bool OpenTD.RcPIDData.Transient = true
getsetinherited

◆ Type

LogicType OpenTD.LogicObject.Type
getinherited

◆ User

string OpenTD.RcPIDData.User = string.Empty
getsetinherited

◆ UserY

string OpenTD.RcPIDData.UserY = string.Empty
getsetinherited

◆ Windup

bool OpenTD.RcPIDData.Windup = false
getsetinherited

◆ XUnits

UnitsData.UnitsType OpenTD.RcPIDData.XUnits = UnitsData.UnitsType.DIMENSIONLESS
getsetinherited

◆ YUnits

UnitsData.UnitsType OpenTD.RcPIDData.YUnits = UnitsData.UnitsType.DIMENSIONLESS
getsetinherited

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

Connect with Ansys