Skip to main content

OpenTD reference 2026 R1

Class Dataset

Last update: 09.03.2026

Namespace: OpenTD.Results.Dataset
Assembly: OpenTD.Results.dll

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

public abstract class Dataset : IDataset

Inheritance

object ← Dataset

Derived

SimpleDataset

Implements

IDataset

Inherited Members

object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()

Constructors

Dataset()

public Dataset()

Properties

AutoCommenter

protected AutoCommenter AutoCommenter { get; set; }

Property Value

AutoCommenter

AutoNamer

protected AutoNamer AutoNamer { get; set; }

Property Value

AutoNamer

Comment

public string Comment { get; set; }

Property Value

string

InternalSuggestedComment

public string InternalSuggestedComment { get; set; }

Property Value

string

InternalSuggestedName

public string InternalSuggestedName { get; set; }

Property Value

string

Name

public string Name { get; set; }

Property Value

string

Source

The name of the source of the data.

public virtual string Source { get; protected set; }

Property Value

string

UDFAManager

protected IUDFAManager UDFAManager { get; set; }

Property Value

IUDFAManager

Units

The unit system of the dataset.

public UnitsData Units { get; set; }

Property Value

UnitsData

Methods

Close()

public abstract void Close()

GetAbszro()

public abstract Dimensional<Temp> GetAbszro()

Returns

Dimensional<Temp>

GetConductorIds(string)

public abstract List<long> GetConductorIds(string submodel)

Parameters

submodel string

Returns

List<long>

GetConstraintData(long, DataSubtype, UnitsData)

public abstract DataArray GetConstraintData(long constraintNumber, DataSubtype subtype = null, UnitsData units = null)

Parameters

constraintNumber long

subtype DataSubtype

units UnitsData

Returns

DataArray

GetData(DataItemIdentifierCollection)

Gets data for a collection of data items (e.g., "MAIN.T10", "FLOW.TL40", etc.).

public abstract DataArrayCollection GetData(DataItemIdentifierCollection dataItems)

Parameters

dataItems DataItemIdentifierCollection

Returns

DataArrayCollection

A DataArrayCollection for the requested dataItems.

GetData(params string[])

public virtual DataArrayCollection GetData(params string[] sindaNames)

Parameters

sindaNames string[]

Returns

DataArrayCollection

GetData(ItemIdentifierCollection, DataSubtype, UnitsData)

public virtual DataArrayCollection GetData(ItemIdentifierCollection itemIds, DataSubtype subtype, UnitsData units = null)

Parameters

itemIds ItemIdentifierCollection

subtype DataSubtype

units UnitsData

Returns

DataArrayCollection

GetDataAtRecord(DataSubtype, long)

Gets all data for a given subtype at a single record. If recordNum is invalid, or if no data of the given subtype exists at the record, will return an empty DataArray.

public abstract DataArray GetDataAtRecord(DataSubtype subtype, long recordNum)

Parameters

subtype DataSubtype

recordNum long

Returns

DataArray

Exceptions

OpenTDException

Thrown if the DataSubtype represents a character UDFA.

GetFluidSubmodels()

public abstract List<string> GetFluidSubmodels()

Returns

List<string>

GetFtieIds(string)

public abstract List<long> GetFtieIds(string submodel)

Parameters

submodel string

Returns

List<long>

GetIfaceIds(string)

public abstract List<long> GetIfaceIds(string submodel)

Parameters

submodel string

Returns

List<long>

GetInternalIndex(DataTypes, string, long)

The 0-indexed position of the given Sinda entity in arrays returned by GetDataAtRecord. Returns -1 if entity can't be found.

public abstract long GetInternalIndex(DataTypes dataType, string submodel, long id)

Parameters

dataType DataTypes

submodel string

id long

Returns

long

See Also

Dataset.GetDataAtRecord(DataSubtype, long)

GetInternalIndex(string)

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

public virtual long GetInternalIndex(string registerName)

Parameters

registerName string

Returns

long

See Also

Dataset.GetRegisterDataAtRecord(long, DataSubtype, UnitsData)

GetLoopcoData()

public abstract List<long> GetLoopcoData()

Returns

List<long>

GetLoopctData()

public abstract List<long> GetLoopctData()

Returns

List<long>

GetLumpIds(string)

public abstract List<long> GetLumpIds(string submodel)

Parameters

submodel string

Returns

List<long>

GetNamedInt(IntegerNames)

public long GetNamedInt(IntegerNames name)

Parameters

name IntegerNames

Returns

long

GetNamedInt(string)

public abstract long GetNamedInt(string name)

Parameters

name string

Returns

long

GetNamedIntArray(ArrayIntegerNames)

public List<long> GetNamedIntArray(ArrayIntegerNames name)

Parameters

name ArrayIntegerNames

Returns

List<long>

GetNamedIntArray(string)

public abstract List<long> GetNamedIntArray(string name)

Parameters

name string

Returns

List<long>

GetNodeIds(string)

public abstract List<long> GetNodeIds(string submodel)

Parameters

submodel string

Returns

List<long>

GetNpcsrec(long)

public abstract long GetNpcsrec(long recordNum)

Parameters

recordNum long

Returns

long

GetNsol(long)

public abstract long GetNsol(long recordNum)

Parameters

recordNum long

Returns

long

GetPathIds(string)

public abstract List<long> GetPathIds(string submodel)

Parameters

submodel string

Returns

List<long>

GetPatmos()

public abstract Dimensional<Pressure> GetPatmos()

Returns

Dimensional<Pressure>

GetRecordNames()

public abstract List<string> GetRecordNames()

Returns

List<string>

GetRecordNumbers()

public abstract List<long> GetRecordNumbers()

Returns

List<long>

GetRecordNumbersAsDataArray()

public DataArray GetRecordNumbersAsDataArray()

Returns

DataArray

GetRegisterData(string, DataSubtype, UnitsData)

Gets all data for a register across all records. If data doesn't exist at a record, NaN will be returned instead.

public abstract DataArray GetRegisterData(string registerName, DataSubtype subtype = null, UnitsData units = null)

Parameters

registerName string

subtype DataSubtype

units UnitsData

Returns

DataArray

GetRegisterDataAtRecord(long, DataSubtype, UnitsData)

Gets all register data at a single record. Use GetRegisterNames to get a list of register names in the same order as the data returned from this method. Or use GetInternalIndex to find the index of a specific register in this list. If recordNum is invalid, or if no register data exists at the record, will return an empty DataArray.

public abstract DataArray GetRegisterDataAtRecord(long recordNum, DataSubtype subtype = null, UnitsData units = null)

Parameters

recordNum long

subtype DataSubtype

units UnitsData

Returns

DataArray

See Also

Dataset.GetRegisterNames(), Dataset.GetInternalIndex(DataTypes, string, long)

GetRegisterNames()

public abstract List<string> GetRegisterNames()

Returns

List<string>

GetReliabilityData(long, DataSubtype, UnitsData)

public abstract DataArray GetReliabilityData(long reliabilityNumber, DataSubtype subtype = null, UnitsData units = null)

Parameters

reliabilityNumber long

subtype DataSubtype

units UnitsData

Returns

DataArray

GetSelfSuggestedComment()

protected virtual string GetSelfSuggestedComment()

Returns

string

GetSelfSuggestedName()

protected virtual string GetSelfSuggestedName()

Returns

string

GetSigma()

public abstract Dimensional<StefanBoltzmann> GetSigma()

Returns

Dimensional<StefanBoltzmann>

GetThermalSubmodels()

public abstract List<string> GetThermalSubmodels()

Returns

List<string>

GetTieIds(string)

public abstract List<long> GetTieIds(string submodel)

Parameters

submodel string

Returns

List<long>

GetTimes()

public abstract DataArray GetTimes()

Returns

DataArray

GetTimesOrRecordNumbers()

public DataArray GetTimesOrRecordNumbers()

Returns

DataArray

GetUDFAManager()

public IUDFAManager GetUDFAManager()

Returns

IUDFAManager

GetUdcaData(DataItemIdentifierCollection)

Gets data for a collection of data items representing character UDFAs.

public abstract List<List<string>> GetUdcaData(DataItemIdentifierCollection dataItems)

Parameters

dataItems DataItemIdentifierCollection

Returns

List<List<string>>

A DataArrayCollection for the requested dataItems.

Exceptions

OpenTDException

Thrown if any of items in dataItems do not specify character UDFAs

GetUdcaDataAtRecord(DataSubtype, long)

Gets the UDFA of strings represented by a DataSubtype at a given record

public abstract List<string> GetUdcaDataAtRecord(DataSubtype subtype, long recordNum)

Parameters

subtype DataSubtype

recordNum long

Record number from which to extract UDFA strings.

Returns

List<string>

A list of character UDFA values.

Exceptions

OpenTDException

Thrown if the DataSubtype represents a noncharacter UDFA.

GetUdfasAtRecord(long)

Gets DataSubtypes UDFA at the given record number.

public abstract List<DataSubtype> GetUdfasAtRecord(long recordNum)

Parameters

recordNum long

Record number from which to extract UDFA subtypes.

Returns

List<DataSubtype>

A list of DataSubtype objects.

ReOpen()

public abstract void ReOpen()

Relay<T_collection, T_item>(T_collection)

protected List<T_item> Relay<T_collection, T_item>(T_collection x) where T_collection : IEnumerable

Parameters

x T_collection

Returns

List<T_item>

Type Parameters

T_collection

T_item

Relay<T_item>(List<T_item>)

protected List<T_item> Relay<T_item>(List<T_item> x)

Parameters

x List<T_item>

Returns

List<T_item>

Type Parameters

T_item

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

UnitsChangedSinceLastRead()

protected bool UnitsChangedSinceLastRead()

Returns

bool

See Also

IAutoName, SaveXFile, SaveFile, CSR, DataArray

Connect with Ansys