Monitor class stores information to track the changes of a value. A monitored item could be a emission or an energy result of a process, pathway, mix, technology, etc. This class defines how to track this object, and sets alarms in case of a values get out the defined Min and Max boundaries. More...

Inheritance diagram for Greet.DataStructureV3.Monitor:

Public Member Functions
	Monitor ()
	Creates an instance of a Monitor with mean set to 0 and torerence to 0.5% This is the constructor that should be used from the GUI to build a new Monitor instance More...

	Monitor (GData data, XmlNode node)
	Creates a new Monitor instance from an XML node read from the project file. More...

override void	Clear ()
	Clears all values stored from previous simulations More...

void	CreateMeanParameter (GData data, string unitOrGroup, double value)

void	CreateToleranceParameter (GData data, string unitOrGroup, double value)

override LightValue	GetCurrentCalculationValue ()
	Returns the current value for the lastest calculation run More...

string	ToString (GData data)

override XmlNode	ToXmlNode (XmlDocument doc, bool exportingResults=false)
	Outputs the data of the monitor value in XML format for saving More...

Properties
override Dictionary< int, LightValue >	CalculationResultsValues `[get]`

override MonitorExcelLocationData	ExcelLocationData `[get, set]`

String	FunctionalUnitName `[get, set]`

string	Header `[get, set]`

int	Id `[get, set]`
	Unique ID for that instance of a Monitored item More...

override bool	IsAlert `[get, set]`
	If True an alert is going to be thrown if the monitored value is too high or too low comparing to the defined average value and tolerence More...

ItemType	ItemType `[get, set]`
	Defines which type of Item is beeing monitored More...

override int	LatestCalculationRunIndex `[get]`

override Parameter	Mean `[get, set]`
	Mean value used to calculate weather or not an alert should be thrown More...

int	MixId `[get, set]`

override MonitorCollectionType	MonitorType `[get, set]`
	Specifies if the monitored item is an emission or a resource More...

Guid	OutputId `[get, set]`

int	PathwayId `[get, set]`

double	PreferedFunctionalAmount `[get, set]`

String	PreferedFunctionalUnitName `[get, set]`

Guid	ProcessVertexId `[get, set]`

MonitorReferenceType	ReferenceType `[get]`
	Returns the state of the monitor item or which type of output is beeing monitored More...

int	ResourceId `[get, set]`
	The material ID corresponding to the product of the monitored output More...

override Parameter	Tolerance `[get, set]`
	Tolerence to calculate the min and max boundaries for checking if the current value is within acceptable limits More...

override Dictionary< int, IValue >	Values `[get]`

Properties inherited from Greet.DataStructureV3.AMonitor
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...

Additional Inherited Members
Protected Attributes inherited from Greet.DataStructureV3.AMonitor
string	uniqueId
	A unique name for the Monitor item whithin the list of all monitored item More...

Detailed Description

Monitor class stores information to track the changes of a value. A monitored item could be a emission or an energy result of a process, pathway, mix, technology, etc. This class defines how to track this object, and sets alarms in case of a values get out the defined Min and Max boundaries.

Constructor & Destructor Documentation

Greet.DataStructureV3.Monitor.Monitor ( )

Creates an instance of a Monitor with mean set to 0 and torerence to 0.5% This is the constructor that should be used from the GUI to build a new Monitor instance

Parameters

data	The database to which this monitor is going to be applied
meanUnit	The unit for the mean value, is it kilograms? joules?

Greet.DataStructureV3.Monitor.Monitor	(	GData	data,
		XmlNode	node
	)

Creates a new Monitor instance from an XML node read from the project file.

Parameters

node

Member Function Documentation

override void Greet.DataStructureV3.Monitor.Clear ( )

virtual

Clears all values stored from previous simulations

Implements Greet.DataStructureV3.AMonitor.

override LightValue Greet.DataStructureV3.Monitor.GetCurrentCalculationValue ( )

virtual

Returns the current value for the lastest calculation run

Returns

Implements Greet.DataStructureV3.AMonitor.

override XmlNode Greet.DataStructureV3.Monitor.ToXmlNode	(	XmlDocument	doc,
		bool	exportingResults = `false`
	)

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

Implements Greet.DataStructureV3.AMonitor.

Property Documentation

override Dictionary<int, LightValue> Greet.DataStructureV3.Monitor.CalculationResultsValues

get

Results for each iterations of the calculations

Keys are the simulation number, values are the normalized results in default unit wihtout beeing adapted for a specific functional unit

override MonitorExcelLocationData Greet.DataStructureV3.Monitor.ExcelLocationData

getset

Used if the user wants to speicify a location in a spreadsheet, was used for automated testing but has not other uses than that

int Greet.DataStructureV3.Monitor.Id

getset

Unique ID for that instance of a Monitored item

override bool Greet.DataStructureV3.Monitor.IsAlert

getset

If True an alert is going to be thrown if the monitored value is too high or too low comparing to the defined average value and tolerence

ItemType Greet.DataStructureV3.Monitor.ItemType

getset

Defines which type of Item is beeing monitored

override Parameter Greet.DataStructureV3.Monitor.Mean

getset

Mean value used to calculate weather or not an alert should be thrown

int Greet.DataStructureV3.Monitor.MixId

getset

If the monitored item is used to monitor the output of a Mix

Then represents the Mix ID from which the output is monitored, -1 otherwise

override MonitorCollectionType Greet.DataStructureV3.Monitor.MonitorType

getset

Specifies if the monitored item is an emission or a resource

Guid Greet.DataStructureV3.Monitor.OutputId

getset

Output ID beeing monitored in a Mix, Pathway or ProcessReference

int Greet.DataStructureV3.Monitor.PathwayId

getset

If the monitored item is used to monitor the output of a Pathway, or when used to monitor a ProcessReference within a Pathway

Then represents the Pathway ID from which the output is monitored, -1 otherwise

Guid Greet.DataStructureV3.Monitor.ProcessVertexId

getset

If the monitored item is used to monitor the output of a Process within a pathway

Then represents the Process ID from which the output is monitored, -1 otherwise

MonitorReferenceType Greet.DataStructureV3.Monitor.ReferenceType

get

Returns the state of the monitor item or which type of output is beeing monitored

Returns: MonitorReferenceType detailling the current ReferenceType for this Monitor instance

int Greet.DataStructureV3.Monitor.ResourceId

getset

The material ID corresponding to the product of the monitored output

override Parameter Greet.DataStructureV3.Monitor.Tolerance

getset

Tolerence to calculate the min and max boundaries for checking if the current value is within acceptable limits

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

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

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation