Skip to main content

OpenTD .NET4 reference 2025 R2

OpenTD.Results.Dataset.TextTransientFile Class Reference

Last update: 16.07.2025

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

Inheritance diagram for OpenTD.Results.Dataset.TextTransientFile:
OpenTD.Results.Dataset.SimpleDatasetOpenTD.Results.Dataset.ISimpleDatasetOpenTD.Results.Dataset.IDatasetOpenTD.Results.Dataset.DatasetOpenTD.Results.Dataset.ISimpleDatasetOpenTD.Results.Dataset.IDatasetOpenTD.Results.Dataset.IAutoNameOpenTD.Results.Dataset.IDatasetOpenTD.Results.Dataset.IAutoNameOpenTD.Results.Dataset.IAutoCommentOpenTD.Results.Dataset.IAutoNameOpenTD.Results.Dataset.IAutoName

Public Member Functions

 TextTransientFile (string pathname, DataSubtype dataSubtype=null, UnitsData units=null)
 
override DataArrayCollection GetAllData (bool includeXDataAsFirstArray=true)
 
DataArray GetData (string submodel, long id)
 
override List< long > GetConductorIds (string submodel)
 
override List< string > GetFluidSubmodels ()
 
override List< long > GetFtieIds (string submodel)
 
override List< long > GetIfaceIds (string submodel)
 
override List< long > GetLumpIds (string submodel)
 
override List< long > GetNodeIds (string submodel)
 
override List< long > GetPathIds (string submodel)
 
override List< long > GetRecordNumbers ()
 Text Transient files don't have record numbers, so this returns a list of sequential integers starting at 0.
 
override List< string > GetThermalSubmodels ()
 
override List< long > GetTieIds (string submodel)
 
override DataArray GetTimes ()
 
override Dimensional< Temp > GetAbszro ()
 
override DataArray GetConstraintData (long constraintNumber, DataSubtype subtype=null, UnitsData units=null)
 
override DataArray GetRegisterDataAtRecord (long recordNum, DataSubtype subtype=null, UnitsData units=null)
 
override List< string > GetUdcaDataAtRecord (DataSubtype subtype, long recordNum)
 
override DataArray GetDataAtRecord (DataSubtype subtype, long recordNum)
 
override long GetInternalIndex (DataTypes dataType, string submodel, long id)
 
override List< long > GetLoopcoData ()
 
override List< long > GetLoopctData ()
 
override long GetNamedInt (string name)
 
override List< long > GetNamedIntArray (string name)
 
override long GetNpcsrec (long recordNum)
 
override long GetNsol (long recordNum)
 
override Dimensional< Pressure > GetPatmos ()
 
override List< string > GetRecordNames ()
 
override List< DataSubtype > GetUdfasAtRecord (long recordNum)
 
override DataArray GetRegisterData (string registerName, DataSubtype subtype=null, UnitsData units=null)
 
override List< string > GetRegisterNames ()
 
override DataArray GetReliabilityData (long reliabilityNumber, DataSubtype subtype=null, UnitsData units=null)
 
override Dimensional< StefanBoltzmann > GetSigma ()
 
override DataArrayCollection GetData (DataItemIdentifierCollection dataItems)
 
virtual DataArrayCollection GetData (params string[] sindaNames)
 
virtual DataArrayCollection GetData (ItemIdentifierCollection itemIds, DataSubtype subtype, UnitsData units=null)
 
override List< List< string > > GetUdcaData (DataItemIdentifierCollection dataItems)
 
override void Close ()
 
override void ReOpen ()
 
DataArray GetRecordNumbersAsDataArray ()
 
DataArray GetTimesOrRecordNumbers ()
 
long GetNamedInt (IntegerNames name)
 
List< long > GetNamedIntArray (ArrayIntegerNames name)
 
virtual long GetInternalIndex (string registerName)
 The 0-indexed position of the given register in arrays returned by GetRegisterDataAtRecord. Returns -1 if registerName can't be found.
 
override string ToString ()
 

Protected Member Functions

override string GetSelfSuggestedName ()
 
bool UnitsChangedSinceLastRead ()
 
virtual string GetSelfSuggestedComment ()
 
List< T_item > Relay< T_collection, T_item > (T_collection x)
 
List< T_item > Relay< T_item > (List< T_item > x)
 

Properties

string Pathname [get]
 
DataTypeFamilies DataTypeFamily [get]
 
DataTypes DataType [get]
 
DataSubtype Subtype [get]
 
string Label [get]
 
UnitsData Units [get, set]
 The unit system of the dataset.
 
virtual string Source [get, protected set]
 The name of the source of the data.
 
IUDFAManager UDFAManager = null [get, set]
 
AutoNamer AutoNamer [get, set]
 
string Name [get, set]
 
string InternalSuggestedName [get, set]
 
AutoCommenter AutoCommenter [get, set]
 
string Comment [get, set]
 
string InternalSuggestedComment [get, set]
 

Detailed Description

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

See also
OpenTD.Results.Dataset.SimpleDataset, OpenTD.Results.Dataset.ISimpleDataset, OpenTD.Results.Dataset.IDataset

Constructor & Destructor Documentation

◆ TextTransientFile()

OpenTD.Results.Dataset.TextTransientFile.TextTransientFile ( string pathname,
DataSubtype dataSubtype = null,
UnitsData units = null )
inline

Member Function Documentation

◆ Close()

override void OpenTD.Results.Dataset.SimpleDataset.Close ( )
inlineinherited

◆ GetAbszro()

override Dimensional< Temp > OpenTD.Results.Dataset.TextTransientFile.GetAbszro ( )
inline

◆ GetAllData()

override DataArrayCollection OpenTD.Results.Dataset.TextTransientFile.GetAllData ( bool includeXDataAsFirstArray = true)
inline

◆ GetConductorIds()

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetConductorIds ( string submodel)
inline

◆ GetConstraintData()

override DataArray OpenTD.Results.Dataset.TextTransientFile.GetConstraintData ( long constraintNumber,
DataSubtype subtype = null,
UnitsData units = null )
inline

◆ GetData() [1/4]

virtual DataArrayCollection OpenTD.Results.Dataset.Dataset.GetData ( ItemIdentifierCollection itemIds,
DataSubtype subtype,
UnitsData units = null )
inlinevirtualinherited

◆ GetData() [2/4]

virtual DataArrayCollection OpenTD.Results.Dataset.Dataset.GetData ( params string[] sindaNames)
inlinevirtualinherited

◆ GetData() [3/4]

override DataArrayCollection OpenTD.Results.Dataset.SimpleDataset.GetData ( DataItemIdentifierCollection dataItems)
inlineinherited

◆ GetData() [4/4]

DataArray OpenTD.Results.Dataset.TextTransientFile.GetData ( string submodel,
long id )
inline

◆ GetDataAtRecord()

override DataArray OpenTD.Results.Dataset.TextTransientFile.GetDataAtRecord ( DataSubtype subtype,
long recordNum )
inline

◆ GetFluidSubmodels()

override List< string > OpenTD.Results.Dataset.TextTransientFile.GetFluidSubmodels ( )
inline

◆ GetFtieIds()

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetFtieIds ( string submodel)
inline

◆ GetIfaceIds()

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetIfaceIds ( string submodel)
inline

◆ GetInternalIndex() [1/2]

virtual long OpenTD.Results.Dataset.Dataset.GetInternalIndex ( string registerName)
inlinevirtualinherited

The 0-indexed position of the given register in arrays returned by GetRegisterDataAtRecord. Returns -1 if registerName can't be found.

See also
OpenTD.Results.Dataset.Dataset.GetRegisterDataAtRecord

Implements OpenTD.Results.Dataset.IDataset.

◆ GetInternalIndex() [2/2]

override long OpenTD.Results.Dataset.TextTransientFile.GetInternalIndex ( DataTypes dataType,
string submodel,
long id )
inline

◆ GetLoopcoData()

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetLoopcoData ( )
inline

◆ GetLoopctData()

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetLoopctData ( )
inline

◆ GetLumpIds()

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetLumpIds ( string submodel)
inline

◆ GetNamedInt() [1/2]

long OpenTD.Results.Dataset.Dataset.GetNamedInt ( IntegerNames name)
inlineinherited

◆ GetNamedInt() [2/2]

override long OpenTD.Results.Dataset.TextTransientFile.GetNamedInt ( string name)
inline

◆ GetNamedIntArray() [1/2]

List< long > OpenTD.Results.Dataset.Dataset.GetNamedIntArray ( ArrayIntegerNames name)
inlineinherited

◆ GetNamedIntArray() [2/2]

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetNamedIntArray ( string name)
inline

◆ GetNodeIds()

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetNodeIds ( string submodel)
inline

◆ GetNpcsrec()

override long OpenTD.Results.Dataset.TextTransientFile.GetNpcsrec ( long recordNum)
inline

◆ GetNsol()

override long OpenTD.Results.Dataset.TextTransientFile.GetNsol ( long recordNum)
inline

◆ GetPathIds()

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetPathIds ( string submodel)
inline

◆ GetPatmos()

override Dimensional< Pressure > OpenTD.Results.Dataset.TextTransientFile.GetPatmos ( )
inline

◆ GetRecordNames()

override List< string > OpenTD.Results.Dataset.TextTransientFile.GetRecordNames ( )
inline

◆ GetRecordNumbers()

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetRecordNumbers ( )
inline

Text Transient files don't have record numbers, so this returns a list of sequential integers starting at 0.

Returns

Implements OpenTD.Results.Dataset.IDataset.

◆ GetRecordNumbersAsDataArray()

DataArray OpenTD.Results.Dataset.Dataset.GetRecordNumbersAsDataArray ( )
inlineinherited

◆ GetRegisterData()

override DataArray OpenTD.Results.Dataset.TextTransientFile.GetRegisterData ( string registerName,
DataSubtype subtype = null,
UnitsData units = null )
inline

◆ GetRegisterDataAtRecord()

override DataArray OpenTD.Results.Dataset.TextTransientFile.GetRegisterDataAtRecord ( long recordNum,
DataSubtype subtype = null,
UnitsData units = null )
inline

◆ GetRegisterNames()

override List< string > OpenTD.Results.Dataset.TextTransientFile.GetRegisterNames ( )
inline

◆ GetReliabilityData()

override DataArray OpenTD.Results.Dataset.TextTransientFile.GetReliabilityData ( long reliabilityNumber,
DataSubtype subtype = null,
UnitsData units = null )
inline

◆ GetSelfSuggestedComment()

virtual string OpenTD.Results.Dataset.Dataset.GetSelfSuggestedComment ( )
inlineprotectedvirtualinherited

◆ GetSelfSuggestedName()

override string OpenTD.Results.Dataset.TextTransientFile.GetSelfSuggestedName ( )
inlineprotectedvirtual

Reimplemented from OpenTD.Results.Dataset.Dataset.

◆ GetSigma()

override Dimensional< StefanBoltzmann > OpenTD.Results.Dataset.TextTransientFile.GetSigma ( )
inline

◆ GetThermalSubmodels()

override List< string > OpenTD.Results.Dataset.TextTransientFile.GetThermalSubmodels ( )
inline

◆ GetTieIds()

override List< long > OpenTD.Results.Dataset.TextTransientFile.GetTieIds ( string submodel)
inline

◆ GetTimes()

override DataArray OpenTD.Results.Dataset.TextTransientFile.GetTimes ( )
inline

◆ GetTimesOrRecordNumbers()

DataArray OpenTD.Results.Dataset.Dataset.GetTimesOrRecordNumbers ( )
inlineinherited

◆ GetUdcaData()

override List< List< string > > OpenTD.Results.Dataset.SimpleDataset.GetUdcaData ( DataItemIdentifierCollection dataItems)
inlineinherited

◆ GetUdcaDataAtRecord()

override List< string > OpenTD.Results.Dataset.TextTransientFile.GetUdcaDataAtRecord ( DataSubtype subtype,
long recordNum )
inline

◆ GetUdfasAtRecord()

override List< DataSubtype > OpenTD.Results.Dataset.TextTransientFile.GetUdfasAtRecord ( long recordNum)

◆ Relay< T_collection, T_item >()

List< T_item > OpenTD.Results.Dataset.Dataset.Relay< T_collection, T_item > ( T_collection x)
inlineprotectedinherited
Type Constraints
T_collection :System.Collections.IEnumerable 

◆ Relay< T_item >()

List< T_item > OpenTD.Results.Dataset.Dataset.Relay< T_item > ( List< T_item > x)
inlineprotectedinherited

◆ ReOpen()

override void OpenTD.Results.Dataset.SimpleDataset.ReOpen ( )
inlineinherited

◆ ToString()

override string OpenTD.Results.Dataset.Dataset.ToString ( )
inlineinherited

◆ UnitsChangedSinceLastRead()

bool OpenTD.Results.Dataset.Dataset.UnitsChangedSinceLastRead ( )
inlineprotectedinherited

Property Documentation

◆ AutoCommenter

AutoCommenter OpenTD.Results.Dataset.Dataset.AutoCommenter
getsetprotectedinherited

◆ AutoNamer

AutoNamer OpenTD.Results.Dataset.Dataset.AutoNamer
getsetprotectedinherited

◆ Comment

string OpenTD.Results.Dataset.Dataset.Comment
getsetinherited

◆ DataType

DataTypes OpenTD.Results.Dataset.TextTransientFile.DataType
get

◆ DataTypeFamily

DataTypeFamilies OpenTD.Results.Dataset.TextTransientFile.DataTypeFamily
get

◆ InternalSuggestedComment

string OpenTD.Results.Dataset.Dataset.InternalSuggestedComment
getsetinherited

◆ InternalSuggestedName

string OpenTD.Results.Dataset.Dataset.InternalSuggestedName
getsetinherited

◆ Label

string OpenTD.Results.Dataset.TextTransientFile.Label
get

◆ Name

string OpenTD.Results.Dataset.Dataset.Name
getsetinherited

◆ Pathname

string OpenTD.Results.Dataset.TextTransientFile.Pathname
get

◆ Source

virtual string OpenTD.Results.Dataset.Dataset.Source
getprotected setinherited

The name of the source of the data.

Implements OpenTD.Results.Dataset.IDataset.

◆ Subtype

DataSubtype OpenTD.Results.Dataset.TextTransientFile.Subtype
get

◆ UDFAManager

IUDFAManager OpenTD.Results.Dataset.Dataset.UDFAManager = null
getsetprotectedinherited

◆ Units

UnitsData OpenTD.Results.Dataset.Dataset.Units
getsetinherited

The unit system of the dataset.

Implements OpenTD.Results.Dataset.IDataset.


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

Connect with Ansys