Class SpreadsheetDataFile
Last update: 09.03.2026Namespace: OpenTD.Results.Dataset
Assembly: OpenTD.Results.dll
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.
public class SpreadsheetDataFile : SimpleDataset, ISimpleDataset, IDataset
Inheritance
object ← Dataset ← SimpleDataset ← SpreadsheetDataFile
Implements
Inherited Members
SimpleDataset.GetAllData(bool), SimpleDataset.GetData(DataItemIdentifierCollection), SimpleDataset.GetUdcaData(DataItemIdentifierCollection), SimpleDataset.Close(), SimpleDataset.ReOpen(), Dataset.GetData(DataItemIdentifierCollection), Dataset.GetUdcaData(DataItemIdentifierCollection), Dataset.GetData(params string[]), Dataset.GetData(ItemIdentifierCollection, DataSubtype, UnitsData), Dataset.GetDataAtRecord(DataSubtype, long), Dataset.GetRegisterDataAtRecord(long, DataSubtype, UnitsData), Dataset.GetUdfasAtRecord(long), Dataset.GetUdcaDataAtRecord(DataSubtype, long), Dataset.GetConstraintData(long, DataSubtype, UnitsData), Dataset.GetReliabilityData(long, DataSubtype, UnitsData), Dataset.GetRegisterData(string, DataSubtype, UnitsData), Dataset.GetRecordNumbers(), Dataset.GetRecordNumbersAsDataArray(), Dataset.GetRecordNames(), Dataset.GetTimes(), Dataset.GetTimesOrRecordNumbers(), Dataset.GetNsol(long), Dataset.GetNpcsrec(long), Dataset.GetSigma(), Dataset.GetAbszro(), Dataset.GetPatmos(), Dataset.GetLoopctData(), Dataset.GetLoopcoData(), Dataset.GetNamedInt(IntegerNames), Dataset.GetNamedInt(string), Dataset.GetNamedIntArray(ArrayIntegerNames), Dataset.GetNamedIntArray(string), Dataset.GetThermalSubmodels(), Dataset.GetFluidSubmodels(), Dataset.GetRegisterNames(), Dataset.GetLumpIds(string), Dataset.GetPathIds(string), Dataset.GetTieIds(string), Dataset.GetFtieIds(string), Dataset.GetIfaceIds(string), Dataset.GetNodeIds(string), Dataset.GetConductorIds(string), Dataset.GetInternalIndex(DataTypes, string, long), Dataset.GetInternalIndex(string), Dataset.Units, Dataset.UnitsChangedSinceLastRead(), Dataset.Source, Dataset.Close(), Dataset.ReOpen(), Dataset.UDFAManager, Dataset.GetUDFAManager(), Dataset.AutoNamer, Dataset.Name, Dataset.InternalSuggestedName, Dataset.GetSelfSuggestedName(), Dataset.ToString(), Dataset.AutoCommenter, Dataset.Comment, Dataset.InternalSuggestedComment, Dataset.GetSelfSuggestedComment(), Dataset.Relay<T_collection, T_item>(T_collection), Dataset.Relay<T_item>(List<T_item>), object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
SpreadsheetDataFile(string)
public SpreadsheetDataFile(string pathname)
Parameters
pathname string
Fields
DisallowedDelimiters
public readonly char[] DisallowedDelimiters
Field Value
char[]
Properties
Delimiters
An array of delimiters to use when parsing the input file. Defaults to comma and tab, i.e., either of those characters will be treated as a column delimiter when found in the input file. Cannot be any of the following since they're used for units expressions: /-()^ or space.
public char[] Delimiters { get; set; }
Property Value
char[]
Pathname
public string Pathname { get; }
Property Value
Methods
GetAbszro()
public override Dimensional<Temp> GetAbszro()
Returns
Dimensional<Temp>
GetAllData(bool)
public override DataArrayCollection GetAllData(bool includeXDataAsFirstArray = true)
Parameters
includeXDataAsFirstArray bool
Returns
GetConductorIds(string)
public override List<long> GetConductorIds(string submodel)
Parameters
submodel string
Returns
GetConstraintData(long, DataSubtype, UnitsData)
public override DataArray GetConstraintData(long constraintNumber, DataSubtype subtype = null, UnitsData units = null)
Parameters
constraintNumber long
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 override DataArray GetDataAtRecord(DataSubtype subtype, long recordNum)
Parameters
subtype DataSubtype
recordNum long
Returns
Exceptions
OpenTDException
Thrown if the DataSubtype
represents a character UDFA.
GetFluidSubmodels()
public override List<string> GetFluidSubmodels()
Returns
GetFtieIds(string)
public override List<long> GetFtieIds(string submodel)
Parameters
submodel string
Returns
GetIfaceIds(string)
public override 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 override long GetInternalIndex(DataTypes dataType, string submodel, long id)
Parameters
dataType DataTypes
submodel string
id long
Returns
See Also
Dataset.GetDataAtRecord(DataSubtype, long)
GetLoopcoData()
public override List<long> GetLoopcoData()
Returns
GetLoopctData()
public override List<long> GetLoopctData()
Returns
GetLumpIds(string)
public override List<long> GetLumpIds(string submodel)
Parameters
submodel string
Returns
GetNamedInt(string)
public override long GetNamedInt(string name)
Parameters
name string
Returns
GetNamedIntArray(string)
public override List<long> GetNamedIntArray(string name)
Parameters
name string
Returns
GetNodeIds(string)
public override List<long> GetNodeIds(string submodel)
Parameters
submodel string
Returns
GetNpcsrec(long)
public override long GetNpcsrec(long recordNum)
Parameters
recordNum long
Returns
GetNsol(long)
public override long GetNsol(long recordNum)
Parameters
recordNum long
Returns
GetPathIds(string)
public override List<long> GetPathIds(string submodel)
Parameters
submodel string
Returns
GetPatmos()
public override Dimensional<Pressure> GetPatmos()
Returns
Dimensional<Pressure>
GetRecordNames()
public override List<string> GetRecordNames()
Returns
GetRecordNumbers()
SpreadsheetDataFiles don't have record numbers, so this returns a list of sequential integers starting at 0.
public override List<long> GetRecordNumbers()
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 override 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 override 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 override List<string> GetRegisterNames()
Returns
GetReliabilityData(long, DataSubtype, UnitsData)
public override DataArray GetReliabilityData(long reliabilityNumber, DataSubtype subtype = null, UnitsData units = null)
Parameters
reliabilityNumber long
subtype DataSubtype
units UnitsData
Returns
GetSelfSuggestedName()
protected override string GetSelfSuggestedName()
Returns
GetSigma()
public override Dimensional<StefanBoltzmann> GetSigma()
Returns
Dimensional<StefanBoltzmann>
GetThermalSubmodels()
public override List<string> GetThermalSubmodels()
Returns
GetTieIds(string)
public override List<long> GetTieIds(string submodel)
Parameters
submodel string
Returns
GetTimes()
public override DataArray GetTimes()
Returns
GetUdcaDataAtRecord(DataSubtype, long)
Gets the UDFA of strings represented by a DataSubtype at a given record
public override 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 override List<DataSubtype> GetUdfasAtRecord(long recordNum)
Parameters
recordNum long
Record number from which to extract UDFA subtypes.
Returns
A list of DataSubtype objects.