Types for working with solution results. More...

Namespaces
namespace	Topology
	Contains types that can be used to determine model topology from solution results, without having to use Thermal Desktop.

Classes
class	AutoCommenter
	<exclude > More...

class	AutoNamer
	<exclude > More...

class	AverageDataArray
	A DerivedDataArray that returns the average value across its InputCollection for each record. DataArrays in the InputCollection must all be the same length and have the same data subtype. More...

class	Browser
	Factory for creating a Browser.

class	CachingBrowser

class	CompareAssertion
	Contains a Comparer and an assertion about whether the Datasets it tests are expected to be equal. More...

class	CompareData

class	Comparer
	Use to compare two Datasets. More...

class	CompareSuite
	Use a CompareSuite to test whether multiple pairs of Datasets are equal or not. Tests a set of CompareAssertions and collects the results. More...

class	ConcatenatedDataset
	A DerivedDataset that joins its InputDatasets together. Use it when you have multiple Datasets that represent sequential events. You can use the bool ShiftTimes to determine whether it adds the previous final time to all the times in the next Dataset. The default is that it does, i.e., it assumes that all of your input Datasets start at time 0. More...

class	ConductorHeat
	Represents heatrate data for a conductor connection. More...

class	CSR
	A Dataset representing one CSR directory. Units are automatically read from the CSR, if available. More...

class	DataArray
	Data is returned from Datasets in the form of DataArrays, which in addition to containing the actual data, also know the physical dimension of the data, what units it is in, and have a reference to the Dataset it came from. Use the GetValues methods to get the data as lists of doubles, or use DataArrays directly as inputs to SimplePlots. More...

class	DataArrayCollection
	A collection of DataArrays, with some metadata describing them. More...

class	DataArrayEnumerator
	Used internally when iterating over the values in a DataArray. More...

class	DataItemIdentifier
	Identifies a data subtype (T, TL, PL, etc.) – with an optional fluid constituent (A, B, W, etc.) – associated with an "item" (an entity (node, lump, etc.), register, record number, etc.), e.g., MAIN.T6, FLOW.PL100, FLOW.GTA10, MYREGISTER DIMENSIONLESS. Note: the Units member is only applicable to registers. If null, default units will be assumed. More...

class	DataItemIdentifierCollection
	Collection of DataItemIdentifiers. More...

class	Dataset
	An abstract class representing a set of solution results from a Sinda run. Returns data as DataArrays. More...

class	DatasetCache

class	DatasetFactory
	Use to load various datasets from disk.

class	DatasetSlice
	A DerivedDataset that accepts only one InputDataset and returns data for a time slice within that Dataset. Use when you're only interested in a certain time slice within your results. More...

class	DataSubtype
	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...

class	DerivedDataArray
	A DerivedDataArray is a DataArray that gets its data by operating on its InputCollection of DataArrays. For example, a SelectMaxDataArray selects the DataArray with the maximum value and returns data from it only. An AverageDataArray returns the average value of its InputCollection at each record. To create your own custom DerivedDataArray, inherit from this class and override at least the SetDerivedData() method. More...

class	DerivedDataset
	A dataset derived from one or more input datasets. When you request data from a DerivedDataset, it performs an operation on the input datasets to combine their data. For example, a ConcatenatedDataset stitches together all of the data from its input datasets. More...

struct	Exceedance
	Contains information about an item that exceeds a tolerance. More...

struct	ExceedancePlot
	Contains information about a plot that displays an Exceedance. More...

class	Extensions

class	FormulaDataArray
	A DerivedDataArray that generate values using a formula that references 0 or more arrays from its InputCollection. More...

struct	FullStandardDataSubtype
	Represents a StandardDataSubtype (XG, XMDOT, etc.) and a fluid constituent (A, W, etc.) More...

class	FunctionalUDFAReader
	<exclude > More...

class	HeatratesBetween
	Helper class for `NodeHeatrates` providing summary calculations for heatrates between "From" and "To" node collections. Positive heatrates indicate heat flowing out of the From set. More...

interface	IAutoComment
	<exclude > More...

interface	IAutoName
	<exclude > More...

interface	IBrowser
	`IBrowser` interface providing methods for Heatmap and HeatBetween nodes and node collecions. More...

interface	ICompareData
	Represents an algorithm for comparing all data of a single DataSubtype (T, TL, etc.) between two datasets. Objects that implement this interface can be used within Comparer.ComparisonMethods or Comparer.DefaultComparisonMethod. See PercentDifferenceCompareData for an example implementation. More...

interface	IComparerInput
	Collects together all of the Comparer members that will be input to an ICompareData object. More...

interface	IComparerOutput
	Collects together all of the Comparer members that will be output from an ICompareData object. More...

interface	IDataset
	An interface to save files, CSR's, spreadsheets and other objects that store solution data. More...

interface	ISimpleDataset
	Provides a method to get all data at once from a small dataset. More...

class	ItemIdentifier
	A class to generalize "items" that are associated with data, e.g., entities (nodes, lumps, etc.), registers, record numbers, etc. More...

class	ItemIdentifierCollection
	Collection of ItemIdentifiers. More...

interface	IUDFAManager
	<exclude > More...

interface	IUDFAReader
	<exclude > More...

class	MaxDataArray
	A DerivedDataArray that returns the maximum value across its InputCollection for each record. DataArrays in the InputCollection must all be the same length and have the same data subtype. More...

class	MinDataArray
	A DerivedDataArray that returns the minimum value across its InputCollection for each record. DataArrays in the InputCollection must all be the same length and have the same data subtype. More...

class	NodeConductorHeatrates
	Rerpesents a node and the heatrates for connected conductors. More...

class	NodeHeatrates
	Holds a node and heatrates for its connected conductors and ties. More...

class	NodeTieHeatrates
	Rerpesents a node and the heatrates for connected ties. More...

class	OneSubtypeDerivedDataArray
	A derived data array where all DataArrays in the InputCollection have the same subtype, e.g., they are all arrays of TL data. More...

class	PercentDifferenceCompareData
	This ICompareData implementation compares data of a single subtype (T, TL, etc.) for all applicable common entities (nodes or lumps or... etc.) between two datasets by examining the percent difference between pairs of values at each record for each common-named entity. For this comparison, Datasets must have the same number of records. More...

class	RecordFocusedDataset
	<exclude > More...

class	SaveFile
	A Dataset representing one save file. Units are automatically read from the save file, if available. More...

class	SaveXFile
	A Dataset representing one savex file. Units are automatically read from the savex file, if available. More...

class	SelectMaxDataArray
	A SelectOneDataArray that selects the DataArray with the maximum value and returns data from it only. More...

class	SelectMinDataArray
	A SelectOneDataArray that selects the DataArray with the minimum value and returns data from it only. More...

class	SelectOneDataArray
	A DerivedDataArray that uses some criterion to select one of its input DataArrays and returns data solely from it. More...

class	SimpleDataset
	Base class for simple datasets for which it might make sense to get all of the data at once using a single method. Implements the OpenTD.Results.Dataset.Dataset Implements the OpenTD.Results.Dataset.ISimpleDataset Implements the OpenTD.Results.Dataset.IDataset More...

class	SinapsXManager

class	SpreadsheetDataFile
	Dataset representing data stored in a csv-style file. Each column is a series, while each row is a record. The first row contains DataItemIdentifiers. The second row contains units. Third and subsequent rows contain data. "NaN" or empty cells are treated as NaN. Default delimiters are comma and tab. All registers (except TIMEN) are considered dimensionless and their units are ignored. The name "time" (case-insensitive) can also be used for TIMEN. More...

class	SumDataArray
	A DerivedDataArray that returns the sum across its InputCollection for each record. DataArrays in the InputCollection must all have the same data subtype. More...

class	TextTransientFile
	Represents a TD text transient file, a text-file containing results or test data in a format specified in the TD manual. Implements the OpenTD.Results.Dataset.SimpleDataset Implements the OpenTD.Results.Dataset.ISimpleDataset Implements the OpenTD.Results.Dataset.IDataset More...

class	TieHeat
	Represents heatrate data for a tie connection. More...

class	UDFADescriptor
	Describes a user-defined Fortran array (UDFA) More...

class	UDFAManager
	<exclude > More...

class	WeightedAverageDataArray
	A DerivedDataArray that returns a weighted average value across its InputCollection for each record. DataArrays in the InputCollection must all be the same length and have the same data subtype. Note: if IgnoreNaNInCalculations is true, NaN in input and weighting arrays will be treated as 0.0. More...

Enumerations
enum	DataTypeFamilies { THERMAL , FLUID , OTHER , NOT_SET }
	Results data families (thermal, fluid, etc.) More...

enum	DataTypes { SUBMODEL , FLUID_SUBMODEL , REGISTER , NODE , CONDUCTOR , LUMP , PATH , TIE , FTIE , IFACE , OTHER , NOT_SET }
	Results data types (node, lump, etc.) More...

enum	StandardDataSubtypes { NOT_SET , DIMENSIONLESS , TIMEN , RECORDNUM , CUSTOM , T , C , Q , G , HR , RADK , PL , XL , TL , DL , HL , AL , DF , DG , QDOT , QL , QTM , QCHEM , VOL , MASS , ENERGY , VDOT , COMP , COMPF , COMPW , CX , CY , CZ , XG , XF , PPG , MF , XMDOT , ASL , CASL , ULI , CULI , UVI , CUVI , GL , CGL , FRD , FRH , HEN , IDGC , PH , ZJ , ZR , AST , CAST , ULT , CULT , UVT , CUVT , GT , CGT , VBUB , VDRP , EMTANK , UTANK , FR , REY , XMA , AF , DeltaP , XUPK , ENTUPK , ERATE , DUPI , DUPJ , AFI , AFJ , GK , HK , EI , EJ , DH , TLEN , FK , IPDC , MREG , WRF , CURV , DEFF , UPF , FC , FPOW , AC , HC , FCLM , FCTM , BFI , BFJ , CXI , CYI , CZI , CXJ , CYJ , CZJ , FD , FG , AM , DK , SMFR , SVFR , TPF , FKB , RC , CFC , XVH , XVL , PSET , FKH , FKL , RLAG , OFAC , AORI , MODO , CDIS , ELLD , MODA , AORI_L , AORI_H , AORI_C , AORI_T , SPD , GPMP , GFR , HPMP , DGDH , EFFP , QTMK , TORQ , GCF , HCF , TCF , ANPSH , RNPSH , ANSS , RNSS , SSCF , CCE , CCH , VCOR , EFFVF , GVF , HVF , LIMP , GTURB , HTURB , UCR , DTURB , EFFM , EFFA , GCOMP , HCOMP , CNS , EFFV , DISP , EFFVM , EFFVA , MODEC , DHI , DHJ , AFTH , RAD_R , RAD_A , FKI , FKJ , ROTR , RVR , RADI , RADJ , VAI , VAJ , VXI , VXJ , REW , REX , MCH , MCH_USED , HCH , FRC , PLTH , TLTH , XLTH , ISCHOK , FDAS , FUAS , ASPU , CASPU , ASPD , CASPD , ULPU , CULPU , ULPD , CULPD , UVPU , CUVPU , UVPD , CUVPD , GU , CGU , GD , CGD , UA , QTIE , DeltaT , UAM , UB , UEDT , AHT , TEF , DUPN , DUPL , XNUL , XNLM , XNLA , XNTM , XNTA , CDB , UER , UEC , UEH , UEV , UED , UEK , UECP , UEP , UET , RLAM , RTURB , CHFF , HFFL , XNB , NTWOP , FQ , ACCM , DEPTH , THKL , HCON , CSF , SPR , DCH , Vtot , DeltaIP , VHI , VLO , EMA , FPV , PA , PB , VA , VB , DUPA , DUPB , DPAB , DPDV , VZRO , XIL , XIH , VSUB , RCAP , RBP , GF , QF , DUPC , DUPD }
	Results data subtypes (T, TL, PL, etc.) More...

enum	FluidConstituents { NOT_SET , A , B , C , D , E , F , G , H , I , J , K , L , M , N , O , P , Q , R , S , T , U , V , W , X , Y , Z , DEFAULT }
	For fluid submodels with multiple fluid constituents. More...

enum	IntegerNames { NMXC , NNOD , NGT , NUELEM , NAMCEL , NAELEM , NTL , NTK , NTT , NTIET , NCELEM , NTTB , MMODS , NUMFLM , LMPTOT , PATTOT , TIETOT , NNARS , NUMS , NUMREG , NRGREL , NRGINT , NDESV , NCSTNM , NTI , NFTIET , NRCSTN , NLCHM }
	Sinda results standard integer names. More...

enum	ArrayIntegerNames { NUMSPE , LCHM , LSPT , FLONUM , PTHNUM , PNTTNK , PNTJNC , PNTPLN , PNTTUB , PNTCNT , PNTIFC , PNTFTI , PNTTIE }
	Sinda results standard names for integer arrays. More...

enum	UDFAType { USER_INPUT_LENGTH = 0 , LUMPS , PATHS , TIES , IFACES , NODES , CONDS , FTIES , FLUID_SUB , THERMAL_SUB , INVALID_UDFA_TYPE }
	Type of entity (if any) associated with UDFA. More...

Detailed Description

Types for working with solution results.

Enumeration Type Documentation

◆ ArrayIntegerNames

enum OpenTD.Results.Dataset.ArrayIntegerNames

Sinda results standard names for integer arrays.

Enumerator
NUMSPE
LCHM
LSPT
FLONUM
PTHNUM
PNTTNK
PNTJNC
PNTPLN
PNTTUB
PNTCNT
PNTIFC
PNTFTI
PNTTIE

◆ DataTypeFamilies

enum OpenTD.Results.Dataset.DataTypeFamilies

Results data families (thermal, fluid, etc.)

Enumerator
THERMAL
FLUID
OTHER
NOT_SET

◆ DataTypes

enum OpenTD.Results.Dataset.DataTypes

Results data types (node, lump, etc.)

Enumerator
SUBMODEL
FLUID_SUBMODEL
REGISTER
NODE
CONDUCTOR
LUMP
PATH
TIE
FTIE
IFACE
OTHER
NOT_SET

◆ FluidConstituents

enum OpenTD.Results.Dataset.FluidConstituents

For fluid submodels with multiple fluid constituents.

Enumerator
NOT_SET
A
B
C
D
E
F
G
H
I
J
K
L
M
N
O
P
Q
R
S
T
U
V
W
X
Y
Z
DEFAULT

◆ IntegerNames

enum OpenTD.Results.Dataset.IntegerNames

Sinda results standard integer names.

Enumerator
NMXC
NNOD
NGT
NUELEM
NAMCEL
NAELEM
NTL
NTK
NTT
NTIET
NCELEM
NTTB
MMODS
NUMFLM
LMPTOT
PATTOT
TIETOT
NNARS
NUMS
NUMREG
NRGREL
NRGINT
NDESV
NCSTNM
NTI
NFTIET
NRCSTN
NLCHM

◆ StandardDataSubtypes

enum OpenTD.Results.Dataset.StandardDataSubtypes

Results data subtypes (T, TL, PL, etc.)

Enumerator
NOT_SET
DIMENSIONLESS
TIMEN
RECORDNUM
CUSTOM
T
C
Q
G
HR
RADK
PL
XL
TL
DL
HL
AL
DF
DG
QDOT
QL
QTM
QCHEM
VOL
MASS
ENERGY
VDOT
COMP
COMPF
COMPW
CX
CY
CZ
XG
XF
PPG
MF
XMDOT
ASL
CASL
ULI
CULI
UVI
CUVI
GL
CGL
FRD
FRH
HEN
IDGC
PH
ZJ
ZR
AST
CAST
ULT
CULT
UVT
CUVT
GT
CGT
VBUB
VDRP
EMTANK
UTANK
FR
REY
XMA
AF
DeltaP
XUPK
ENTUPK
ERATE
DUPI
DUPJ
AFI
AFJ
GK
HK
EI
EJ
DH
TLEN
FK
IPDC
MREG
WRF
CURV
DEFF
UPF
FC
FPOW
AC
HC
FCLM
FCTM
BFI
BFJ
CXI
CYI
CZI
CXJ
CYJ
CZJ
FD
FG
AM
DK
SMFR
SVFR
TPF
FKB
RC
CFC
XVH
XVL
PSET
FKH
FKL
RLAG
OFAC
AORI
MODO
CDIS
ELLD
MODA
AORI_L
AORI_H
AORI_C
AORI_T
SPD
GPMP
GFR
HPMP
DGDH
EFFP
QTMK
TORQ
GCF
HCF
TCF
ANPSH
RNPSH
ANSS
RNSS
SSCF
CCE
CCH
VCOR
EFFVF
GVF
HVF
LIMP
GTURB
HTURB
UCR
DTURB
EFFM
EFFA
GCOMP
HCOMP
CNS
EFFV
DISP
EFFVM
EFFVA
MODEC
DHI
DHJ
AFTH
RAD_R
RAD_A
FKI
FKJ
ROTR
RVR
RADI
RADJ
VAI
VAJ
VXI
VXJ
REW
REX
MCH
MCH_USED
HCH
FRC
PLTH
TLTH
XLTH
ISCHOK
FDAS
FUAS
ASPU
CASPU
ASPD
CASPD
ULPU
CULPU
ULPD
CULPD
UVPU
CUVPU
UVPD
CUVPD
GU
CGU
GD
CGD
UA
QTIE
DeltaT
UAM
UB
UEDT
AHT
TEF
DUPN
DUPL
XNUL
XNLM
XNLA
XNTM
XNTA
CDB
UER
UEC
UEH
UEV
UED
UEK
UECP
UEP
UET
RLAM
RTURB
CHFF
HFFL
XNB
NTWOP
FQ
ACCM
DEPTH
THKL
HCON
CSF
SPR
DCH
Vtot
DeltaIP
VHI
VLO
EMA
FPV
PA
PB
VA
VB
DUPA
DUPB
DPAB
DPDV
VZRO
XIL
XIH
VSUB
RCAP
RBP
GF
QF
DUPC
DUPD

◆ UDFAType

enum OpenTD.Results.Dataset.UDFAType

Type of entity (if any) associated with UDFA.

Enumerator
USER_INPUT_LENGTH
LUMPS
PATHS
TIES
IFACES
NODES
CONDS
FTIES
FLUID_SUB
THERMAL_SUB
INVALID_UDFA_TYPE

OpenTD .NET4 reference 2025 R2

OpenTD.Results.Dataset Namespace Reference

Namespaces

Classes

Enumerations