Class Dataset
Last update: 09.03.2026Namespace: 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
Derived
Implements
Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
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
InternalSuggestedComment
public string InternalSuggestedComment { get; set; }
Property Value
InternalSuggestedName
public string InternalSuggestedName { get; set; }
Property Value
Name
public string Name { get; set; }
Property Value
Source
The name of the source of the data.
public virtual string Source { get; protected set; }
Property Value
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
GetConstraintData(long, DataSubtype, UnitsData)
public abstract DataArray GetConstraintData(long constraintNumber, DataSubtype subtype = null, UnitsData units = null)
Parameters
constraintNumber long
subtype DataSubtype
units UnitsData
Returns
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
A DataArrayCollection for the requested dataItems.
GetData(params string[])
public virtual DataArrayCollection GetData(params string[] sindaNames)
Parameters
sindaNames string[]
Returns
GetData(ItemIdentifierCollection, DataSubtype, UnitsData)
public virtual DataArrayCollection GetData(ItemIdentifierCollection itemIds, DataSubtype subtype, UnitsData units = null)
Parameters
itemIds ItemIdentifierCollection
subtype DataSubtype
units UnitsData
Returns
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
Exceptions
OpenTDException
Thrown if the DataSubtype
represents a character UDFA.
GetFluidSubmodels()
public abstract List<string> GetFluidSubmodels()
Returns
GetFtieIds(string)
public abstract List<long> GetFtieIds(string submodel)
Parameters
submodel string
Returns
GetIfaceIds(string)
public abstract List<long> GetIfaceIds(string submodel)
Parameters
submodel string
Returns
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
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
See Also
Dataset.GetRegisterDataAtRecord(long, DataSubtype, UnitsData)
GetLoopcoData()
public abstract List<long> GetLoopcoData()
Returns
GetLoopctData()
public abstract List<long> GetLoopctData()
Returns
GetLumpIds(string)
public abstract List<long> GetLumpIds(string submodel)
Parameters
submodel string
Returns
GetNamedInt(IntegerNames)
public long GetNamedInt(IntegerNames name)
Parameters
name IntegerNames
Returns
GetNamedInt(string)
public abstract long GetNamedInt(string name)
Parameters
name string
Returns
GetNamedIntArray(ArrayIntegerNames)
public List<long> GetNamedIntArray(ArrayIntegerNames name)
Parameters
name ArrayIntegerNames
Returns
GetNamedIntArray(string)
public abstract List<long> GetNamedIntArray(string name)
Parameters
name string
Returns
GetNodeIds(string)
public abstract List<long> GetNodeIds(string submodel)
Parameters
submodel string
Returns
GetNpcsrec(long)
public abstract long GetNpcsrec(long recordNum)
Parameters
recordNum long
Returns
GetNsol(long)
public abstract long GetNsol(long recordNum)
Parameters
recordNum long
Returns
GetPathIds(string)
public abstract List<long> GetPathIds(string submodel)
Parameters
submodel string
Returns
GetPatmos()
public abstract Dimensional<Pressure> GetPatmos()
Returns
Dimensional<Pressure>
GetRecordNames()
public abstract List<string> GetRecordNames()
Returns
GetRecordNumbers()
public abstract List<long> GetRecordNumbers()
Returns
GetRecordNumbersAsDataArray()
public DataArray GetRecordNumbersAsDataArray()
Returns
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
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
See Also
Dataset.GetRegisterNames(), Dataset.GetInternalIndex(DataTypes, string, long)
GetRegisterNames()
public abstract List<string> GetRegisterNames()
Returns
GetReliabilityData(long, DataSubtype, UnitsData)
public abstract DataArray GetReliabilityData(long reliabilityNumber, DataSubtype subtype = null, UnitsData units = null)
Parameters
reliabilityNumber long
subtype DataSubtype
units UnitsData
Returns
GetSelfSuggestedComment()
protected virtual string GetSelfSuggestedComment()
Returns
GetSelfSuggestedName()
protected virtual string GetSelfSuggestedName()
Returns
GetSigma()
public abstract Dimensional<StefanBoltzmann> GetSigma()
Returns
Dimensional<StefanBoltzmann>
GetThermalSubmodels()
public abstract List<string> GetThermalSubmodels()
Returns
GetTieIds(string)
public abstract List<long> GetTieIds(string submodel)
Parameters
submodel string
Returns
GetTimes()
public abstract DataArray GetTimes()
Returns
GetTimesOrRecordNumbers()
public DataArray GetTimesOrRecordNumbers()
Returns
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
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
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
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
A string that represents the current object.
UnitsChangedSinceLastRead()
protected bool UnitsChangedSinceLastRead()