Greet.DataStructureV3.AMonitor Class Reference

Interface for monitor values. It contains the mehtods and properties that should be implemented by a monitor value. More...

Inheritance diagram for Greet.DataStructureV3.AMonitor:

Public Member Functions
abstract void	Clear ()
	Clears all values stored from previous simulations More...
abstract LightValue	GetCurrentCalculationValue ()
	Returns the current value for the lastest calculation run More...
abstract XmlNode	ToXmlNode (XmlDocument doc, bool exportingResults=false)
	Outputs the data of the monitor value in XML format for saving More...

Protected Attributes
string	uniqueId
	A unique name for the Monitor item whithin the list of all monitored item More...

Properties
abstract Dictionary< int, LightValue >	CalculationResultsValues [get]
	For each calculations, we store a value here, so we can trace how the monitored item evolved More...
abstract MonitorExcelLocationData	ExcelLocationData [get, set]
	Stores the sheet name, cell and unit of the corresponding value found in the Greet Base Excel Sheet. More...
abstract bool	IsAlert [get, set]
abstract int	LatestCalculationRunIndex [get]
	returns the index of the latest calculation stored in this monitor value More...
abstract Parameter	Mean [get, set]
abstract MonitorCollectionType	MonitorType [get, set]
	Indicates the type of value we are monitoring (emission or energy). More...
int	ResultsCount [get]
abstract Parameter	Tolerance [get, set]
string	UniqueId [get, set]
	A name that is unique to that monitored item More...
abstract Dictionary< int, IValue >	Values [get]
Properties inherited from Greet.DataStructureV3.Interfaces.IMonitor
int	ResultsCount [get]
	Returns the number of saved values for this monitored item More...
string	UniqueId [get, set]
	A unique name for that monitored value item More...
Dictionary< int, IValue >	Values [get]
	Results stored from previous simulations More...

Detailed Description

Interface for monitor values. It contains the mehtods and properties that should be implemented by a monitor value.

Member Function Documentation

abstract void Greet.DataStructureV3.AMonitor.Clear ( )

pure virtual

Clears all values stored from previous simulations

Implements Greet.DataStructureV3.Interfaces.IMonitor.

Implemented in Greet.DataStructureV3.Monitor.

abstract LightValue Greet.DataStructureV3.AMonitor.GetCurrentCalculationValue ( )

pure virtual

Returns the current value for the lastest calculation run

Returns

Implemented in Greet.DataStructureV3.Monitor.

abstract XmlNode Greet.DataStructureV3.AMonitor.ToXmlNode ( XmlDocument  doc, bool  exportingResults = false  )

pure virtual

Outputs the data of the monitor value in XML format for saving

Parameters

doc	XML document being written too
exportingResults	A bool that if set true indicates that the calculation result values will be written to the save file.

Returns

Implemented in Greet.DataStructureV3.Monitor.

Member Data Documentation

string Greet.DataStructureV3.AMonitor.uniqueId

protected

A unique name for the Monitor item whithin the list of all monitored item

Property Documentation

abstract Dictionary<int, LightValue> Greet.DataStructureV3.AMonitor.CalculationResultsValues

get

For each calculations, we store a value here, so we can trace how the monitored item evolved

abstract MonitorExcelLocationData Greet.DataStructureV3.AMonitor.ExcelLocationData

getset

Stores the sheet name, cell and unit of the corresponding value found in the Greet Base Excel Sheet.

abstract int Greet.DataStructureV3.AMonitor.LatestCalculationRunIndex

get

returns the index of the latest calculation stored in this monitor value

abstract MonitorCollectionType Greet.DataStructureV3.AMonitor.MonitorType

getset

Indicates the type of value we are monitoring (emission or energy).

string Greet.DataStructureV3.AMonitor.UniqueId

getset

A name that is unique to that monitored item

---

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

• C:/Users/ddieffenthaler/Desktop/SVN/source/greet-dev/main/DataManagement/DataStructureV3/DataV3/Monitoring/AMonitor.cs