Class SaveFile
Last update: 09.03.2026Namespace: OpenTD.Results.Dataset
Assembly: OpenTD.Results.dll
A Dataset representing one save file. Units are automatically read from the save file, if available.
public sealed class SaveFile : RecordFocusedDataset, IDataset
Inheritance
object ← Dataset ← RecordFocusedDataset ← SaveFile
Implements
Inherited Members
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.Source, Dataset.Close(), Dataset.ReOpen(), Dataset.GetUDFAManager(), Dataset.Name, Dataset.InternalSuggestedName, Dataset.ToString(), Dataset.Comment, Dataset.InternalSuggestedComment, object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
SaveFile(string)
public SaveFile(string pathToSave)
Parameters
pathToSave string
Properties
Pathname
public string Pathname { get; }
Property Value
Methods
Close()
public override void Close()
GetAbszro()
public override Dimensional<Temp> GetAbszro()
Returns
Dimensional<Temp>
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
GetData(DataItemIdentifierCollection)
Gets data for a collection of data items (e.g., "MAIN.T10", "FLOW.TL40", etc.).
public override DataArrayCollection GetData(DataItemIdentifierCollection dataItems)
Parameters
dataItems DataItemIdentifierCollection
Returns
A DataArrayCollection for the requested dataItems.
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()
public override List<long> GetRecordNumbers()
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
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
GetUdcaData(DataItemIdentifierCollection)
Gets data for a collection of data items representing character UDFAs.
public override 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 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.
ReOpen()
public override void ReOpen()