An abstract class representing a set of solution results from a Sinda run. Returns data as DataArrays. More...

Inheritance diagram for OpenTD.Results.Dataset.Dataset:

Public Member Functions
	Dataset ()

DataArrayCollection	GetData (DataItemIdentifierCollection dataItems)
	Gets data for a collection of data items (e.g., "MAIN.T10", "FLOW.TL40", etc.).

List< List< string > >	GetUdcaData (DataItemIdentifierCollection dataItems)
	Gets data for a collection of data items representing character UDFAs.

virtual DataArrayCollection	GetData (params string[] sindaNames)

virtual DataArrayCollection	GetData (ItemIdentifierCollection itemIds, DataSubtype subtype, UnitsData units=null)

DataArray	GetDataAtRecord (DataSubtype subtype, long recordNum)
	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.

DataArray	GetRegisterDataAtRecord (long recordNum, DataSubtype subtype=null, UnitsData units=null)
	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.

List< DataSubtype >	GetUdfasAtRecord (long recordNum)
	Gets `DataSubtypes` UDFA at the given record number.

List< string >	GetUdcaDataAtRecord (DataSubtype subtype, long recordNum)
	Gets the UDFA of strings represented by a `DataSubtype` at a given record.

DataArray	GetConstraintData (long constraintNumber, DataSubtype subtype=null, UnitsData units=null)

DataArray	GetReliabilityData (long reliabilityNumber, DataSubtype subtype=null, UnitsData units=null)

DataArray	GetRegisterData (string registerName, DataSubtype subtype=null, UnitsData units=null)
	Gets all data for a register across all records. If data doesn't exist at a record, NaN will be returned instead.

List< long >	GetRecordNumbers ()

DataArray	GetRecordNumbersAsDataArray ()

List< string >	GetRecordNames ()

DataArray	GetTimes ()

DataArray	GetTimesOrRecordNumbers ()

long	GetNsol (long recordNum)

long	GetNpcsrec (long recordNum)

Dimensional< StefanBoltzmann >	GetSigma ()

Dimensional< Temp >	GetAbszro ()

Dimensional< Pressure >	GetPatmos ()

List< long >	GetLoopctData ()

List< long >	GetLoopcoData ()

long	GetNamedInt (IntegerNames name)

long	GetNamedInt (string name)

List< long >	GetNamedIntArray (ArrayIntegerNames name)

List< long >	GetNamedIntArray (string name)

List< string >	GetThermalSubmodels ()

List< string >	GetFluidSubmodels ()

List< string >	GetRegisterNames ()

List< long >	GetLumpIds (string submodel)

List< long >	GetPathIds (string submodel)

List< long >	GetTieIds (string submodel)

List< long >	GetFtieIds (string submodel)

List< long >	GetIfaceIds (string submodel)

List< long >	GetNodeIds (string submodel)

List< long >	GetConductorIds (string submodel)

long	GetInternalIndex (DataTypes dataType, string submodel, long id)
	The 0-indexed position of the given Sinda entity in arrays returned by GetDataAtRecord. Returns -1 if entity can't be found.

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.

void	Close ()

void	ReOpen ()

override string	ToString ()

Protected Member Functions
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
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

An abstract class representing a set of solution results from a Sinda run. Returns data as DataArrays.

See also: OpenTD.Results.Dataset.IAutoName, OpenTD.Results.Dataset.SaveXFile, OpenTD.Results.Dataset.SaveFile, OpenTD.Results.Dataset.CSR, OpenTD.Results.Dataset.DataArray

Constructor & Destructor Documentation

◆ Dataset()

OpenTD.Results.Dataset.Dataset.Dataset ( )

inline

Member Function Documentation

◆ Close()

void OpenTD.Results.Dataset.Dataset.Close ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetAbszro()

Dimensional< Temp > OpenTD.Results.Dataset.Dataset.GetAbszro ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetConductorIds()

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

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetConstraintData()

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

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetData() [1/3]

DataArrayCollection OpenTD.Results.Dataset.Dataset.GetData ( DataItemIdentifierCollection dataItems )

abstract

Gets data for a collection of data items (e.g., "MAIN.T10", "FLOW.TL40", etc.).

Parameters

dataItems

Returns: A DataArrayCollection for the requested dataItems.

Implements OpenTD.Results.Dataset.IDataset.

◆ GetData() [2/3]

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

inlinevirtual

Implements OpenTD.Results.Dataset.IDataset.

◆ GetData() [3/3]

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

inlinevirtual

Implements OpenTD.Results.Dataset.IDataset.

◆ GetDataAtRecord()

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

abstract

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.

Exceptions

OpenTDException Thrown if the DataSubtype represents a character UDFA.

Implements OpenTD.Results.Dataset.IDataset.

◆ GetFluidSubmodels()

List< string > OpenTD.Results.Dataset.Dataset.GetFluidSubmodels ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetFtieIds()

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

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetIfaceIds()

List< long > OpenTD.Results.Dataset.Dataset.GetIfaceIds ( string submodel )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetInternalIndex() [1/2]

long OpenTD.Results.Dataset.Dataset.GetInternalIndex	(	DataTypes	dataType,
		string	submodel,
		long	id )

abstract

The 0-indexed position of the given Sinda entity in arrays returned by GetDataAtRecord. Returns -1 if entity can't be found.

See also: OpenTD.Results.Dataset.Dataset.GetDataAtRecord

Implements OpenTD.Results.Dataset.IDataset.

◆ GetInternalIndex() [2/2]

virtual long OpenTD.Results.Dataset.Dataset.GetInternalIndex ( string registerName )

inlinevirtual

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.

◆ GetLoopcoData()

List< long > OpenTD.Results.Dataset.Dataset.GetLoopcoData ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetLoopctData()

List< long > OpenTD.Results.Dataset.Dataset.GetLoopctData ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetLumpIds()

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

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetNamedInt() [1/2]

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

inline

Implements OpenTD.Results.Dataset.IDataset.

◆ GetNamedInt() [2/2]

long OpenTD.Results.Dataset.Dataset.GetNamedInt ( string name )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetNamedIntArray() [1/2]

List< long > OpenTD.Results.Dataset.Dataset.GetNamedIntArray ( ArrayIntegerNames name )

inline

Implements OpenTD.Results.Dataset.IDataset.

◆ GetNamedIntArray() [2/2]

List< long > OpenTD.Results.Dataset.Dataset.GetNamedIntArray ( string name )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetNodeIds()

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

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetNpcsrec()

long OpenTD.Results.Dataset.Dataset.GetNpcsrec ( long recordNum )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetNsol()

long OpenTD.Results.Dataset.Dataset.GetNsol ( long recordNum )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetPathIds()

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

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetPatmos()

Dimensional< Pressure > OpenTD.Results.Dataset.Dataset.GetPatmos ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetRecordNames()

List< string > OpenTD.Results.Dataset.Dataset.GetRecordNames ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetRecordNumbers()

List< long > OpenTD.Results.Dataset.Dataset.GetRecordNumbers ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetRecordNumbersAsDataArray()

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

inline

Implements OpenTD.Results.Dataset.IDataset.

◆ GetRegisterData()

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

abstract

Gets all data for a register across all records. If data doesn't exist at a record, NaN will be returned instead.

Implements OpenTD.Results.Dataset.IDataset.

◆ GetRegisterDataAtRecord()

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

abstract

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.

See also: OpenTD.Results.Dataset.Dataset.GetRegisterNames, OpenTD.Results.Dataset.Dataset.GetInternalIndex

Implements OpenTD.Results.Dataset.IDataset.

◆ GetRegisterNames()

List< string > OpenTD.Results.Dataset.Dataset.GetRegisterNames ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetReliabilityData()

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

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetSelfSuggestedComment()

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

inlineprotectedvirtual

◆ GetSelfSuggestedName()

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

inlineprotectedvirtual

Reimplemented in OpenTD.Results.Dataset.SpreadsheetDataFile, and OpenTD.Results.Dataset.TextTransientFile.

◆ GetSigma()

Dimensional< StefanBoltzmann > OpenTD.Results.Dataset.Dataset.GetSigma ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetThermalSubmodels()

List< string > OpenTD.Results.Dataset.Dataset.GetThermalSubmodels ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetTieIds()

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

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetTimes()

DataArray OpenTD.Results.Dataset.Dataset.GetTimes ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ GetTimesOrRecordNumbers()

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

inline

Implements OpenTD.Results.Dataset.IDataset.

◆ GetUdcaData()

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

abstract

Gets data for a collection of data items representing character UDFAs.

Parameters

dataItems

Returns: A DataArrayCollection for the requested dataItems.

Exceptions

OpenTDException Thrown if any of items in dataItems do not specify character UDFAs

Implements OpenTD.Results.Dataset.IDataset.

◆ GetUdcaDataAtRecord()

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

abstract

Gets the UDFA of strings represented by a DataSubtype at a given record.

Parameters

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

Implements OpenTD.Results.Dataset.IDataset.

◆ GetUdfasAtRecord()

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

abstract

Gets DataSubtypes UDFA at the given record number.

Parameters

recordNum Record number from which to extract UDFA subtypes.

Returns: A list of DataSubtype objects.

Implements OpenTD.Results.Dataset.IDataset.

◆ Relay< T_collection, T_item >()

List< T_item > OpenTD.Results.Dataset.Dataset.Relay< T_collection, T_item > ( T_collection x )

inlineprotected

Type Constraints

T_collection

:

System.Collections.IEnumerable

◆ Relay< T_item >()

List< T_item > OpenTD.Results.Dataset.Dataset.Relay< T_item > ( List< T_item > x )

inlineprotected

◆ ReOpen()

void OpenTD.Results.Dataset.Dataset.ReOpen ( )

abstract

Implements OpenTD.Results.Dataset.IDataset.

◆ ToString()

override string OpenTD.Results.Dataset.Dataset.ToString ( )

inline

◆ UnitsChangedSinceLastRead()

bool OpenTD.Results.Dataset.Dataset.UnitsChangedSinceLastRead ( )

inlineprotected

Property Documentation

◆ AutoCommenter

AutoCommenter OpenTD.Results.Dataset.Dataset.AutoCommenter

getsetprotected

◆ AutoNamer

AutoNamer OpenTD.Results.Dataset.Dataset.AutoNamer

getsetprotected

◆ Comment

string OpenTD.Results.Dataset.Dataset.Comment

getset

Implements OpenTD.Results.Dataset.IAutoComment.

◆ InternalSuggestedComment

string OpenTD.Results.Dataset.Dataset.InternalSuggestedComment

getset

Implements OpenTD.Results.Dataset.IAutoComment.

◆ InternalSuggestedName

string OpenTD.Results.Dataset.Dataset.InternalSuggestedName

getset

Implements OpenTD.Results.Dataset.IAutoName.

◆ Name

string OpenTD.Results.Dataset.Dataset.Name

getset

Implements OpenTD.Results.Dataset.IAutoName.

◆ Source

virtual string OpenTD.Results.Dataset.Dataset.Source

getprotected set

The name of the source of the data.

Implements OpenTD.Results.Dataset.IDataset.

◆ UDFAManager

IUDFAManager OpenTD.Results.Dataset.Dataset.UDFAManager = null

getsetprotected

◆ Units

UnitsData OpenTD.Results.Dataset.Dataset.Units

getset

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/TDDEV_ALPHA/buildXX/OpenTD.Results/Dataset/Dataset.cs

OpenTD.Results.Dataset.Dataset Class Reference

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Dataset()

Member Function Documentation

◆ Close()

◆ GetAbszro()

◆ 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()

Property Documentation

◆ AutoCommenter

◆ AutoNamer

◆ Comment

◆ InternalSuggestedComment

◆ InternalSuggestedName

◆ Name

◆ Source

◆ UDFAManager

◆ Units

Connect with Ansys