A DerivedDataArray is a DataArray that gets its data by operating on its InputCollection of DataArrays. For example, a SelectMaxDataArray selects the DataArray with the maximum value and returns data from it only. An AverageDataArray returns the average value of its InputCollection at each record. To create your own custom DerivedDataArray, inherit from this class and override at least the SetDerivedData() method. More...

Inheritance diagram for OpenTD.Results.Dataset.DerivedDataArray:

Public Member Functions
	DerivedDataArray (DataArrayCollection inputCollection)

	DerivedDataArray ()

override List< double >	GetValues (UnitsData units)
	Gets the data in the units provided.

virtual void	SetValues (IEnumerable< double > values, DataSubtype subtype=null, UnitsData units=null, ItemIdentifier item=null)

List< double >	GetValues ()
	Gets the data in the current WorkingUnits.

override string	ToString ()

IEnumerator< double >	GetEnumerator ()

Static Public Member Functions
static implicit	operator List< double > (DataArray x)

static implicit	operator List< DataArray > (DataArray x)

Protected Member Functions
override string	GetSelfSuggestedName ()

virtual void	SetDerivedData ()
	For setting ValuesSI, any other derived data.

override void	CheckData ()

virtual string	GetSelfSuggestedComment ()

Protected Attributes
List< double >	ValuesSI

Properties
DataArrayCollection	InputCollection `[get, set]`
	The collection of DataArrays operated upon to derive data.

bool	IgnoreNaNInCalculations `[get, set]`

override IDataset	SourceDataset `[get, set]`
	The source Dataset for the InputCollection.

override ItemIdentifier	SourceItem `[get, set]`
	The SourceItem for the InputCollection.

override int	Count `[get]`

override double	this[int index] `[get, set]`

virtual DataSubtype	Subtype `[get, set]`
	The DataSubtype (T, TL, PL, GTX, etc.)

DataItemIdentifier	SourceDataItem `[get]`
	Combines the SourceItem and Subtype. If either are null, this is null.

UnitsData.UnitsType	Dimension `[get]`
	The physical dimension of this data.

bool	IsInteger `[get]`
	Returns true if the subtype of this data represents integer data.

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 DerivedDataArray is a DataArray that gets its data by operating on its InputCollection of DataArrays. For example, a SelectMaxDataArray selects the DataArray with the maximum value and returns data from it only. An AverageDataArray returns the average value of its InputCollection at each record. To create your own custom DerivedDataArray, inherit from this class and override at least the SetDerivedData() method.

See also: OpenTD.Results.Dataset.DataArray, OpenTD.Results.Dataset.SelectMaxDataArray, OpenTD.Results.Dataset.AverageDataArray

Constructor & Destructor Documentation

◆ DerivedDataArray() [1/2]

OpenTD.Results.Dataset.DerivedDataArray.DerivedDataArray ( DataArrayCollection inputCollection )

inline

◆ DerivedDataArray() [2/2]

OpenTD.Results.Dataset.DerivedDataArray.DerivedDataArray ( )

inline

Member Function Documentation

◆ CheckData()

override void OpenTD.Results.Dataset.DerivedDataArray.CheckData ( )

inlineprotectedvirtual

Reimplemented from OpenTD.Results.Dataset.DataArray.

Reimplemented in OpenTD.Results.Dataset.FormulaDataArray, OpenTD.Results.Dataset.MaxDataArray, OpenTD.Results.Dataset.MinDataArray, OpenTD.Results.Dataset.OneSubtypeDerivedDataArray, OpenTD.Results.Dataset.SelectOneDataArray, and OpenTD.Results.Dataset.WeightedAverageDataArray.

◆ GetEnumerator()

IEnumerator< double > OpenTD.Results.Dataset.DataArray.GetEnumerator ( )

inlineinherited

◆ GetSelfSuggestedComment()

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

inlineprotectedvirtualinherited

◆ GetSelfSuggestedName()

override string OpenTD.Results.Dataset.DerivedDataArray.GetSelfSuggestedName ( )

inlineprotectedvirtual

Reimplemented from OpenTD.Results.Dataset.DataArray.

Reimplemented in OpenTD.Results.Dataset.FormulaDataArray, OpenTD.Results.Dataset.MaxDataArray, OpenTD.Results.Dataset.MinDataArray, OpenTD.Results.Dataset.SelectOneDataArray, OpenTD.Results.Dataset.SumDataArray, and OpenTD.Results.Dataset.WeightedAverageDataArray.

◆ GetValues() [1/2]

List< double > OpenTD.Results.Dataset.DataArray.GetValues ( )

inlineinherited

Gets the data in the current WorkingUnits.

Returns: List<System.Double>.

See also: OpenTD.Units.WorkingUnits

◆ GetValues() [2/2]

override List< double > OpenTD.Results.Dataset.DerivedDataArray.GetValues ( UnitsData units )

inlinevirtual

Gets the data in the units provided.

Parameters

units The units to return the data in.

Returns: List<System.Double>.

Reimplemented from OpenTD.Results.Dataset.DataArray.

Reimplemented in OpenTD.Results.Dataset.SelectOneDataArray.

◆ operator List< DataArray >()

static implicit OpenTD.Results.Dataset.DataArray.operator List< DataArray > ( DataArray x )

inlinestaticinherited

◆ operator List< double >()

static implicit OpenTD.Results.Dataset.DataArray.operator List< double > ( DataArray x )

inlinestaticinherited

◆ SetDerivedData()

virtual void OpenTD.Results.Dataset.DerivedDataArray.SetDerivedData ( )

inlineprotectedvirtual

For setting ValuesSI, any other derived data.

Reimplemented in OpenTD.Results.Dataset.AverageDataArray, OpenTD.Results.Dataset.FormulaDataArray, OpenTD.Results.Dataset.MaxDataArray, OpenTD.Results.Dataset.MinDataArray, OpenTD.Results.Dataset.OneSubtypeDerivedDataArray, OpenTD.Results.Dataset.SelectMaxDataArray, OpenTD.Results.Dataset.SelectMinDataArray, OpenTD.Results.Dataset.SumDataArray, and OpenTD.Results.Dataset.WeightedAverageDataArray.

◆ SetValues()

virtual void OpenTD.Results.Dataset.DataArray.SetValues	(	IEnumerable< double >	values,
		DataSubtype	subtype = null,
		UnitsData	units = null,
		ItemIdentifier	item = null )

inlinevirtualinherited

◆ ToString()

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

inlineinherited

Member Data Documentation

◆ ValuesSI

List<double> OpenTD.Results.Dataset.DataArray.ValuesSI

protectedinherited

Property Documentation

◆ AutoCommenter

AutoCommenter OpenTD.Results.Dataset.DataArray.AutoCommenter

getsetprotectedinherited

◆ AutoNamer

AutoNamer OpenTD.Results.Dataset.DataArray.AutoNamer

getsetprotectedinherited

◆ Comment

string OpenTD.Results.Dataset.DataArray.Comment

getsetinherited

Implements OpenTD.Results.Dataset.IAutoComment.

◆ Count

override int OpenTD.Results.Dataset.DerivedDataArray.Count

get

◆ Dimension

UnitsData.UnitsType OpenTD.Results.Dataset.DataArray.Dimension

getinherited

The physical dimension of this data.

◆ IgnoreNaNInCalculations

bool OpenTD.Results.Dataset.DerivedDataArray.IgnoreNaNInCalculations

getset

◆ InputCollection

DataArrayCollection OpenTD.Results.Dataset.DerivedDataArray.InputCollection

getset

The collection of DataArrays operated upon to derive data.

The input collection.

◆ InternalSuggestedComment

string OpenTD.Results.Dataset.DataArray.InternalSuggestedComment

getsetinherited

Implements OpenTD.Results.Dataset.IAutoComment.

◆ InternalSuggestedName

string OpenTD.Results.Dataset.DataArray.InternalSuggestedName

getsetinherited

Implements OpenTD.Results.Dataset.IAutoName.

◆ IsInteger

bool OpenTD.Results.Dataset.DataArray.IsInteger

getinherited

Returns true if the subtype of this data represents integer data.

◆ Name

string OpenTD.Results.Dataset.DataArray.Name

getsetinherited

Implements OpenTD.Results.Dataset.IAutoName.

◆ SourceDataItem

DataItemIdentifier OpenTD.Results.Dataset.DataArray.SourceDataItem

getinherited

Combines the SourceItem and Subtype. If either are null, this is null.

◆ SourceDataset

override IDataset OpenTD.Results.Dataset.DerivedDataArray.SourceDataset

getset

The source Dataset for the InputCollection.

The source dataset.

Exceptions

OpenTDException Cannot set DerivedDataArray.SourceDataset directly. It will be derived from InputArrays.

◆ SourceItem

override ItemIdentifier OpenTD.Results.Dataset.DerivedDataArray.SourceItem

getset

The SourceItem for the InputCollection.

The source item.

Exceptions

OpenTDException Cannot set DerivedDataArray.SourceItem directly. It will be derived from InputArrays.

◆ Subtype

virtual DataSubtype OpenTD.Results.Dataset.DataArray.Subtype

getsetinherited

The DataSubtype (T, TL, PL, GTX, etc.)

◆ this[int index]

override double OpenTD.Results.Dataset.DerivedDataArray.this[int index]

getset

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

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

OpenTD.Results.Dataset.DerivedDataArray Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DerivedDataArray() [1/2]

◆ DerivedDataArray() [2/2]

Member Function Documentation

◆ CheckData()

◆ GetEnumerator()

◆ GetSelfSuggestedComment()

◆ GetSelfSuggestedName()

◆ GetValues() [1/2]

◆ GetValues() [2/2]

◆ operator List< DataArray >()

◆ operator List< double >()

◆ SetDerivedData()

◆ SetValues()

◆ ToString()

Member Data Documentation

◆ ValuesSI

Property Documentation

◆ AutoCommenter

◆ AutoNamer

◆ Comment

◆ Count

◆ Dimension

◆ IgnoreNaNInCalculations

◆ InputCollection

◆ InternalSuggestedComment

◆ InternalSuggestedName

◆ IsInteger

◆ Name

◆ SourceDataItem

◆ SourceDataset

◆ SourceItem

◆ Subtype

◆ this[int index]

Connect with Ansys