OpenTD.Results.Dataset.SpreadsheetDataFile Class Reference

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. More...

Public Member Functions
	SpreadsheetDataFile (string pathname)
override DataArrayCollection	GetAllData (bool includeXDataAsFirstArray=true)
override List< long >	GetConductorIds (string submodel)
override List< string >	GetFluidSubmodels ()
override List< long >	GetFtieIds (string submodel)
override List< long >	GetIfaceIds (string submodel)
override List< long >	GetLumpIds (string submodel)
override List< long >	GetNodeIds (string submodel)
override List< long >	GetPathIds (string submodel)
override List< long >	GetRecordNumbers ()
	SpreadsheetDataFiles don't have record numbers, so this returns a list of sequential integers starting at 0.
override List< string >	GetThermalSubmodels ()
override List< long >	GetTieIds (string submodel)
override DataArray	GetTimes ()
override List< string >	GetRegisterNames ()
override DataArray	GetRegisterData (string registerName, DataSubtype subtype=null, UnitsData units=null)
override DataArray	GetRegisterDataAtRecord (long recordNum, DataSubtype subtype=null, UnitsData units=null)
override List< string >	GetUdcaDataAtRecord (DataSubtype subtype, long recordNum)
override DataArray	GetDataAtRecord (DataSubtype subtype, long recordNum)
override long	GetInternalIndex (DataTypes dataType, string submodel, long id)
override Dimensional< Temp >	GetAbszro ()
override DataArray	GetConstraintData (long constraintNumber, DataSubtype subtype=null, UnitsData units=null)
override List< long >	GetLoopcoData ()
override List< long >	GetLoopctData ()
override long	GetNamedInt (string name)
override List< long >	GetNamedIntArray (string name)
override long	GetNpcsrec (long recordNum)
override long	GetNsol (long recordNum)
override Dimensional< Pressure >	GetPatmos ()
override DataArray	GetReliabilityData (long reliabilityNumber, DataSubtype subtype=null, UnitsData units=null)
override Dimensional< StefanBoltzmann >	GetSigma ()
override List< string >	GetRecordNames ()
override List< DataSubtype >	GetUdfasAtRecord (long recordNum)
override DataArrayCollection	GetData (DataItemIdentifierCollection dataItems)
virtual DataArrayCollection	GetData (params string[] sindaNames)
virtual DataArrayCollection	GetData (ItemIdentifierCollection itemIds, DataSubtype subtype, UnitsData units=null)
override List< List< string > >	GetUdcaData (DataItemIdentifierCollection dataItems)
override void	Close ()
override void	ReOpen ()
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 ()

Public Attributes
readonly char[]	DisallowedDelimiters = new char[] { '/', '-', '(', ')', '^', ' ' }

Protected Member Functions
override string	GetSelfSuggestedName ()
bool	UnitsChangedSinceLastRead ()
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]
char[]	Delimiters [get, set]
	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.
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

Constructor & Destructor Documentation

◆ SpreadsheetDataFile()

Member Function Documentation

◆ Close()

◆ GetAbszro()

◆ GetAllData()

◆ GetConductorIds()

◆ GetConstraintData()

◆ GetData() [1/3]

◆ GetData() [2/3]

◆ GetData() [3/3]

◆ GetDataAtRecord()

◆ GetFluidSubmodels()

◆ GetFtieIds()

◆ GetIfaceIds()

◆ GetInternalIndex() [1/2]

◆ GetInternalIndex() [2/2]

◆ GetLoopcoData()

◆ GetLoopctData()

◆ GetLumpIds()

◆ GetNamedInt() [1/2]

◆ GetNamedInt() [2/2]

◆ GetNamedIntArray() [1/2]

◆ GetNamedIntArray() [2/2]

◆ GetNodeIds()

◆ GetNpcsrec()

◆ GetNsol()

◆ GetPathIds()

◆ GetPatmos()

◆ GetRecordNames()

◆ GetRecordNumbers()

◆ GetRecordNumbersAsDataArray()

◆ GetRegisterData()

◆ GetRegisterDataAtRecord()

◆ GetRegisterNames()

◆ GetReliabilityData()

◆ GetSelfSuggestedComment()

◆ GetSelfSuggestedName()

◆ GetSigma()

◆ GetThermalSubmodels()

◆ GetTieIds()

◆ GetTimes()

◆ GetTimesOrRecordNumbers()

◆ GetUdcaData()

◆ GetUdcaDataAtRecord()

◆ GetUdfasAtRecord()

◆ Relay< T_collection, T_item >()

◆ Relay< T_item >()

◆ ReOpen()

◆ ToString()

◆ UnitsChangedSinceLastRead()

Member Data Documentation

◆ DisallowedDelimiters

Property Documentation

◆ AutoCommenter

◆ AutoNamer

◆ Comment

◆ Delimiters

◆ InternalSuggestedComment

◆ InternalSuggestedName

◆ Name

◆ Pathname

◆ Source

◆ UDFAManager

◆ Units

---

The documentation for this class was generated from the following file:

• C:/Users/mgarrett/source/repos/BuildsTdSuite/builds/TDDEV_ALPHA/buildXX/OpenTD.Results/Dataset/SpreadsheetDataFile.cs