Skip to main content

OpenTD .NET8 reference 2025 R2

OpenTD.Results.Dataset.SaveXFile Class Reference

Last update: 16.07.2025

A Dataset representing one savex file. Units are automatically read from the savex file, if available. More...

Inheritance diagram for OpenTD.Results.Dataset.SaveXFile:
OpenTD.Results.Dataset.RecordFocusedDatasetOpenTD.Results.Dataset.IDatasetOpenTD.Results.Dataset.DatasetOpenTD.Results.Dataset.IDatasetOpenTD.Results.Dataset.IAutoNameOpenTD.Results.Dataset.IDatasetOpenTD.Results.Dataset.IAutoNameOpenTD.Results.Dataset.IAutoCommentOpenTD.Results.Dataset.IAutoNameOpenTD.Results.Dataset.IAutoName

Public Member Functions

 SaveXFile (string pathToSaveX)
 
override List< List< string > > GetUdcaData (DataItemIdentifierCollection dataItems)
 
override DataArray GetDataAtRecord (DataSubtype subtype, long recordNum)
 
override DataArray GetRegisterDataAtRecord (long recordNum, DataSubtype subtype=null, UnitsData units=null)
 
override List< string > GetUdcaDataAtRecord (DataSubtype subtype, long recordNum)
 
override DataArray GetConstraintData (long constraintNumber, DataSubtype subtype=null, UnitsData units=null)
 
override DataArray GetReliabilityData (long reliabilityNumber, DataSubtype subtype=null, UnitsData units=null)
 
override long GetInternalIndex (DataTypes dataType, string submodel, long id)
 
override List< long > GetRecordNumbers ()
 
override DataArray GetTimes ()
 
override List< string > GetThermalSubmodels ()
 
override List< long > GetNodeIds (string submodel)
 
override List< string > GetRecordNames ()
 
override List< DataSubtype > GetUdfasAtRecord (long recordNum)
 
override long GetNsol (long recordNum)
 
override long GetNpcsrec (long recordNum)
 
override Dimensional< StefanBoltzmann > GetSigma ()
 
override Dimensional< Temp > GetAbszro ()
 
override Dimensional< Pressure > GetPatmos ()
 
override List< long > GetLoopctData ()
 
override List< long > GetLoopcoData ()
 
override long GetNamedInt (string name)
 
override List< long > GetNamedIntArray (string name)
 
override List< string > GetFluidSubmodels ()
 
override List< string > GetRegisterNames ()
 
override List< long > GetLumpIds (string submodel)
 
override List< long > GetPathIds (string submodel)
 
override List< long > GetTieIds (string submodel)
 
override List< long > GetFtieIds (string submodel)
 
override List< long > GetIfaceIds (string submodel)
 
override List< long > GetConductorIds (string submodel)
 
override void Close ()
 
override void ReOpen ()
 
void Dispose ()
 Do not use. To release resources, call Close() instead.
 
override DataArrayCollection GetData (DataItemIdentifierCollection dataItems)
 
virtual DataArrayCollection GetData (params string[] sindaNames)
 
virtual DataArrayCollection GetData (ItemIdentifierCollection itemIds, DataSubtype subtype, UnitsData units=null)
 
override DataArray GetRegisterData (string registerName, DataSubtype subtype=null, UnitsData units=null)
 
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

virtual void Dispose (bool disposing)
 
bool UnitsChangedSinceLastRead ()
 
virtual string GetSelfSuggestedName ()
 
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]
 
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

A Dataset representing one savex file. Units are automatically read from the savex file, if available.

See also
OpenTD.Results.Dataset.Dataset

Constructor & Destructor Documentation

◆ SaveXFile()

OpenTD.Results.Dataset.SaveXFile.SaveXFile ( string pathToSaveX)
inline

Member Function Documentation

◆ Close()

override void OpenTD.Results.Dataset.SaveXFile.Close ( )
inline

◆ Dispose() [1/2]

void OpenTD.Results.Dataset.SaveXFile.Dispose ( )
inline

Do not use. To release resources, call Close() instead.

◆ Dispose() [2/2]

virtual void OpenTD.Results.Dataset.SaveXFile.Dispose ( bool disposing)
inlineprotectedvirtual

◆ GetAbszro()

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

◆ GetConductorIds()

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

◆ GetConstraintData()

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

◆ GetData() [1/3]

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

◆ GetData() [2/3]

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

◆ GetData() [3/3]

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

◆ GetDataAtRecord()

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

◆ GetFluidSubmodels()

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

◆ GetFtieIds()

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

◆ GetIfaceIds()

override List< long > OpenTD.Results.Dataset.SaveXFile.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.SaveXFile.GetInternalIndex ( DataTypes dataType,
string submodel,
long id )
inline

◆ GetLoopcoData()

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

◆ GetLoopctData()

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

◆ GetLumpIds()

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

◆ GetNamedInt() [1/2]

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

◆ GetNamedInt() [2/2]

override long OpenTD.Results.Dataset.SaveXFile.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.SaveXFile.GetNamedIntArray ( string name)
inline

◆ GetNodeIds()

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

◆ GetNpcsrec()

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

◆ GetNsol()

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

◆ GetPathIds()

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

◆ GetPatmos()

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

◆ GetRecordNames()

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

◆ GetRecordNumbers()

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

◆ GetRecordNumbersAsDataArray()

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

◆ GetRegisterData()

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

◆ GetRegisterDataAtRecord()

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

◆ GetRegisterNames()

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

◆ GetReliabilityData()

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

◆ GetSelfSuggestedComment()

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

◆ GetSelfSuggestedName()

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

◆ GetSigma()

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

◆ GetThermalSubmodels()

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

◆ GetTieIds()

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

◆ GetTimes()

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

◆ GetTimesOrRecordNumbers()

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

◆ GetUdcaData()

override List< List< string > > OpenTD.Results.Dataset.SaveXFile.GetUdcaData ( DataItemIdentifierCollection dataItems)
inline

◆ GetUdcaDataAtRecord()

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

◆ GetUdfasAtRecord()

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

◆ 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.SaveXFile.ReOpen ( )
inline

◆ 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

◆ InternalSuggestedComment

string OpenTD.Results.Dataset.Dataset.InternalSuggestedComment
getsetinherited

◆ InternalSuggestedName

string OpenTD.Results.Dataset.Dataset.InternalSuggestedName
getsetinherited

◆ Name

string OpenTD.Results.Dataset.Dataset.Name
getsetinherited

◆ Pathname

string OpenTD.Results.Dataset.SaveXFile.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.

◆ 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/OpenTD/OpenTD.Results/Dataset/SaveXFile.cs

Connect with Ansys