GREET API
Exposed interfaces to create modules that can be loaded in GREET
 All Classes Namespaces Files Functions Enumerations Enumerator Properties Events
Public Member Functions | Properties | List of all members
PlugInsInterfaces.DataTypes.IMonitor Interface Reference

More...

Public Member Functions

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

Properties

Dictionary< int, IResultValue > Values [get]
 Results stored from previous simulations More...
 
String Description [get]
 Returns a short description of the monitored value More...
 
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...
 

Detailed Description

An interface for the monitored results in GREET

Monitored items are a way to record upstream results across multiple iterations of the calculations. For example one might like to record results between multiple calculations and change parameter to see their influence on this monitored results

Another example of use may be for stochastic simulations, one can monitor a result item, run thousands of simulations, and see the distribution of results for that monitored item

Definition at line 17 of file IMonitor.cs.

Member Function Documentation

void PlugInsInterfaces.DataTypes.IMonitor.Clear ( )

Clears all values stored from previous simulations

Property Documentation

String PlugInsInterfaces.DataTypes.IMonitor.Description
get

Returns a short description of the monitored value

Definition at line 37 of file IMonitor.cs.

int PlugInsInterfaces.DataTypes.IMonitor.ResultsCount
get

Returns the number of saved values for this monitored item

Definition at line 44 of file IMonitor.cs.

string PlugInsInterfaces.DataTypes.IMonitor.UniqueId
getset

A unique name for that monitored value item

Definition at line 50 of file IMonitor.cs.

Dictionary<int, IResultValue> PlugInsInterfaces.DataTypes.IMonitor.Values
get

Results stored from previous simulations

Definition at line 30 of file IMonitor.cs.

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