OpenTD .NET4 reference 2025 R2

OpenTD.Results.Dataset.DataSubtype Class Reference

Last update: 16.07.2025

Represents one data subtype, e.g., TL (lump temperature). If using C#, you can supply a StandardDataSubtype anywhere a DataSubtype is expected and it will be implicity converted to a DataSubtype. This also works with a FullStandardDataSubtype. More...

Inheritance diagram for OpenTD.Results.Dataset.DataSubtype:

Public Types

enum  ValueTypes { DOUBLE , INTEGER , STRING , BOOL }
 Value types: double, integer, etc. More...
 

Public Member Functions

 DataSubtype (StandardDataSubtypes stdDataSubtype)
 
 DataSubtype (StandardDataSubtypes stdDataSubtype, FluidConstituents fluidConstituent)
 
 DataSubtype (FullStandardDataSubtype stdDataSubtypeWithFluid)
 
 DataSubtype (UnitsData.UnitsType dimension, bool isDimensionalOnlyIfPositive, string description, string baseSindaDesignator, DataTypes dataType, FluidConstituents fluidConstituent=FluidConstituents.NOT_SET)
 
 DataSubtype (string udfaName, DataTypes dataType, DataSubtype.ValueTypes valueType)
 
 DataSubtype (UnitsData.UnitsType dimension, string description, DataTypes dataType=DataTypes.NOT_SET)
 
 DataSubtype (DataSubtype source, FluidConstituents fluidConstituent)
 
void SetFrom (DataSubtype x)
 
FullStandardDataSubtype GetFullStandardDataSubtype ()
 Gets the FullStandardDataSubtype associated with this subtype.
 
bool Equals (DataSubtype x)
 
override string ToString ()
 
override bool Equals (object obj)
 
override int GetHashCode ()
 

Static Public Member Functions

static implicit operator DataSubtype (StandardDataSubtypes x)
 
static implicit operator DataSubtype (FullStandardDataSubtype x)
 
static bool operator== (DataSubtype x1, DataSubtype x2)
 
static bool operator!= (DataSubtype x1, DataSubtype x2)
 

Properties

ValueTypes ValueType = ValueTypes.DOUBLE [get]
 The type of value that this subtype represents.
 
UnitsData.UnitsType Dimension [get]
 The physical dimension of this subtype, e.g., temperature.
 
bool IsDimensionalOnlyIfPositive [get]
 Determines whether this subtype behaves dimensionally only when positive. (Some Sinda variables are dimensional if positive and just flags if negative.)
 
string Description [get]
 A short description of this subtype, e.g. "lump temperature".
 
string BaseSindaDesignator [get]
 The short string used by Sinda to identify this subtype, e.g., "TL".
 
FluidConstituents FluidConstituent [get]
 For multispecies subtypes, this is the fluid constituent. For non-multispecies subtypes, this should be set to NOT_SET.
 
string SindaDesignator [get]
 The short string used by Sinda to identify this subtype, combined with a fluid constituent letter for multispecies subtypes.
 
bool IsUDFA = false [get]
 Determines whether this subtype describes a UDFA.
 
DataTypeFamilies DataTypeFamily [get]
 The DataTypeFamilies enum (thermal, fluid, other) associated with this subtype.
 
DataTypes DataType [get]
 The DataTypes enum (node, lump, etc.) associated with this subtype.
 
StandardDataSubtypes StandardDataSubtype [get]
 Gets the StandardDataSubtypes enum associated with this subtype.
 
static IEnumerable< StandardDataSubtypes > SupportedStandardDataSubtypes [get]
 

Detailed Description

Represents one data subtype, e.g., TL (lump temperature). If using C#, you can supply a StandardDataSubtype anywhere a DataSubtype is expected and it will be implicity converted to a DataSubtype. This also works with a FullStandardDataSubtype.

See also
OpenTD.Results.Dataset.StandardDataSubtypes, OpenTD.Results.Dataset.FullStandardDataSubtype

Member Enumeration Documentation

◆ ValueTypes

enum OpenTD.Results.Dataset.DataSubtype.ValueTypes

Value types: double, integer, etc.

Enumerator
DOUBLE 
INTEGER 
STRING 
BOOL 

Constructor & Destructor Documentation

◆ DataSubtype() [1/7]

OpenTD.Results.Dataset.DataSubtype.DataSubtype ( StandardDataSubtypes stdDataSubtype)
inline

◆ DataSubtype() [2/7]

OpenTD.Results.Dataset.DataSubtype.DataSubtype ( StandardDataSubtypes stdDataSubtype,
FluidConstituents fluidConstituent )
inline

◆ DataSubtype() [3/7]

OpenTD.Results.Dataset.DataSubtype.DataSubtype ( FullStandardDataSubtype stdDataSubtypeWithFluid)
inline

◆ DataSubtype() [4/7]

OpenTD.Results.Dataset.DataSubtype.DataSubtype ( UnitsData.UnitsType dimension,
bool isDimensionalOnlyIfPositive,
string description,
string baseSindaDesignator,
DataTypes dataType,
FluidConstituents fluidConstituent = FluidConstituents::NOT_SET )
inline

◆ DataSubtype() [5/7]

OpenTD.Results.Dataset.DataSubtype.DataSubtype ( string udfaName,
DataTypes dataType,
DataSubtype.ValueTypes valueType )
inline

◆ DataSubtype() [6/7]

OpenTD.Results.Dataset.DataSubtype.DataSubtype ( UnitsData.UnitsType dimension,
string description,
DataTypes dataType = DataTypes::NOT_SET )
inline

◆ DataSubtype() [7/7]

OpenTD.Results.Dataset.DataSubtype.DataSubtype ( DataSubtype source,
FluidConstituents fluidConstituent )
inline

Member Function Documentation

◆ Equals() [1/2]

bool OpenTD.Results.Dataset.DataSubtype.Equals ( DataSubtype x)
inline

◆ Equals() [2/2]

override bool OpenTD.Results.Dataset.DataSubtype.Equals ( object obj)
inline

◆ GetFullStandardDataSubtype()

FullStandardDataSubtype OpenTD.Results.Dataset.DataSubtype.GetFullStandardDataSubtype ( )
inline

Gets the FullStandardDataSubtype associated with this subtype.

◆ GetHashCode()

override int OpenTD.Results.Dataset.DataSubtype.GetHashCode ( )
inline

◆ operator DataSubtype() [1/2]

static implicit OpenTD.Results.Dataset.DataSubtype.operator DataSubtype ( FullStandardDataSubtype x)
inlinestatic

◆ operator DataSubtype() [2/2]

static implicit OpenTD.Results.Dataset.DataSubtype.operator DataSubtype ( StandardDataSubtypes x)
inlinestatic

◆ operator!=()

static bool OpenTD.Results.Dataset.DataSubtype.operator!= ( DataSubtype x1,
DataSubtype x2 )
inlinestatic

◆ operator==()

static bool OpenTD.Results.Dataset.DataSubtype.operator== ( DataSubtype x1,
DataSubtype x2 )
inlinestatic

◆ SetFrom()

void OpenTD.Results.Dataset.DataSubtype.SetFrom ( DataSubtype x)
inline

◆ ToString()

override string OpenTD.Results.Dataset.DataSubtype.ToString ( )
inline

Property Documentation

◆ BaseSindaDesignator

string OpenTD.Results.Dataset.DataSubtype.BaseSindaDesignator
get

The short string used by Sinda to identify this subtype, e.g., "TL".

Returns
System.String.

◆ DataType

DataTypes OpenTD.Results.Dataset.DataSubtype.DataType
get

The DataTypes enum (node, lump, etc.) associated with this subtype.

◆ DataTypeFamily

DataTypeFamilies OpenTD.Results.Dataset.DataSubtype.DataTypeFamily
get

The DataTypeFamilies enum (thermal, fluid, other) associated with this subtype.

Returns
DataTypeFamilies.

◆ Description

string OpenTD.Results.Dataset.DataSubtype.Description
get

A short description of this subtype, e.g. "lump temperature".

Returns
System.String.

◆ Dimension

UnitsData.UnitsType OpenTD.Results.Dataset.DataSubtype.Dimension
get

The physical dimension of this subtype, e.g., temperature.

Returns
UnitsData.UnitsType.

◆ FluidConstituent

FluidConstituents OpenTD.Results.Dataset.DataSubtype.FluidConstituent
get

For multispecies subtypes, this is the fluid constituent. For non-multispecies subtypes, this should be set to NOT_SET.

◆ IsDimensionalOnlyIfPositive

bool OpenTD.Results.Dataset.DataSubtype.IsDimensionalOnlyIfPositive
get

Determines whether this subtype behaves dimensionally only when positive. (Some Sinda variables are dimensional if positive and just flags if negative.)

Returns
true if [is dimensional only if positive]; otherwise, false.

◆ IsUDFA

bool OpenTD.Results.Dataset.DataSubtype.IsUDFA = false
get

Determines whether this subtype describes a UDFA.

Returns
true if this instance is a UDFA; otherwise, false.

◆ SindaDesignator

string OpenTD.Results.Dataset.DataSubtype.SindaDesignator
get

The short string used by Sinda to identify this subtype, combined with a fluid constituent letter for multispecies subtypes.

◆ StandardDataSubtype

StandardDataSubtypes OpenTD.Results.Dataset.DataSubtype.StandardDataSubtype
get

Gets the StandardDataSubtypes enum associated with this subtype.

Returns
StandardDataSubtypes.

◆ SupportedStandardDataSubtypes

IEnumerable<StandardDataSubtypes> OpenTD.Results.Dataset.DataSubtype.SupportedStandardDataSubtypes
staticget

◆ ValueType

ValueTypes OpenTD.Results.Dataset.DataSubtype.ValueType = ValueTypes.DOUBLE
get

The type of value that this subtype represents.

Returns
The ValuesTypes value for this subtype.
The documentation for this class was generated from the following file:
  • C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/TDDEV_ALPHA/buildXX/OpenTD.Results/Dataset/DataSubtype.cs

Connect with Ansys