Greet 2014
Documentation for the GREET 2014 API
 All Classes Namespaces Functions Variables Enumerations Properties Events
Greet.DataStructureV3.ResultsStorage.CanonicalProcess Class Reference

Defines the reference to a single process. The objects of this class are used to store calculation results More...

Inheritance diagram for Greet.DataStructureV3.ResultsStorage.CanonicalProcess:
Greet.DataStructureV3.Interfaces.IProcessReference

Public Member Functions

 CanonicalProcess (int reference, int pathway_ref)
 
void ClearAllResults ()
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
List< CanonicalProcessGetProcesses ()
 
Dictionary< IIO, ResultsGetResults (GData data)
 Returns results associated with all the outputs for that process More...
 
Dictionary< IIO, IResultsGetUpstreamResults (IData data)
 Upstream results associated to that process reference at it's position in the pathway More...
 
XmlNode ResultsToXml (XmlDocument doc)
 This function writes the results in a form of xml More...
 
override string ToString ()
 
- Public Member Functions inherited from Greet.DataStructureV3.IHaveResults
Dictionary< IIO, ResultsGetResults (GData data)
 

Public Attributes

Dictionary< int, ResultsCreditedAmounts = new Dictionary<int, Results>()
 Stores the credited amounts for allocated and displaced co-products. Used in order to be able to show these individual credits to the user in the co-products editor. More...
 
Dictionary< Guid, CanonicalInputInputsResults = new Dictionary<Guid, CanonicalInput>()
 Stores the results for each inputs relatively all outputs (no allocation or displacement) All the inputs results are stored here as they depend on the previous values in a pathway and cannot be stored in an instance of a process More...
 
string Name = ""
 
Dictionary< Guid, CanonicalOutputOutputsResults = new Dictionary<Guid, CanonicalOutput>()
 Stores the results for each output by taking all the inputs amounts balanced to the respective outputs amounts or using allocation methods. Displaced outputs are not represented in this collection as they are not usable in downstream processes. Indexes are the resource ID associated to the upstrams at this point. For outputs all enems are balanced. More...
 
int pathwayReference = -1
 

Static Public Attributes

static KeyValuePair< string, bool > EmissionsAll = new KeyValuePair<string, bool>("Life Cycle", true)
 
static KeyValuePair< string, bool > EnergyAllIncluded = new KeyValuePair<string, bool>("Life Cycle", true)
 

Properties

int ModelId [get, set]
 
string Notes [get, set]
 
Guid VertexId [get, set]
 Vertex ID associated with that process reference in the pathway More...
 
- Properties inherited from Greet.DataStructureV3.Interfaces.IProcessReference
int ModelId [get, set]
 Reference to the ID of the process to be used in the pathway More...
 

Detailed Description

Defines the reference to a single process. The objects of this class are used to store calculation results

Member Function Documentation

Dictionary<IIO, Results> Greet.DataStructureV3.ResultsStorage.CanonicalProcess.GetResults ( GData  data)

Returns results associated with all the outputs for that process

Parameters
dataData where the ModelID process is available
Returns
Dictionary of outputs and results
Dictionary<IIO, IResults> Greet.DataStructureV3.ResultsStorage.CanonicalProcess.GetUpstreamResults ( IData  data)

Upstream results associated to that process reference at it's position in the pathway

This is the prefered way to get the upstream for a product from any process reference. The upstream associated with a IPathway is equal the the upstream associated with the last process reference of this given pathway.

Parameters
dataData object needed for references
Returns
Dictionary containing the allocated results for each output of the IProcess refered by this process reference in a IPathway

Implements Greet.DataStructureV3.Interfaces.IProcessReference.

XmlNode Greet.DataStructureV3.ResultsStorage.CanonicalProcess.ResultsToXml ( XmlDocument  doc)

This function writes the results in a form of xml

Returns
node which contains the calculation results

Member Data Documentation

Dictionary<int, Results> Greet.DataStructureV3.ResultsStorage.CanonicalProcess.CreditedAmounts = new Dictionary<int, Results>()

Stores the credited amounts for allocated and displaced co-products. Used in order to be able to show these individual credits to the user in the co-products editor.

Dictionary<Guid, CanonicalInput> Greet.DataStructureV3.ResultsStorage.CanonicalProcess.InputsResults = new Dictionary<Guid, CanonicalInput>()

Stores the results for each inputs relatively all outputs (no allocation or displacement) All the inputs results are stored here as they depend on the previous values in a pathway and cannot be stored in an instance of a process

Dictionary<Guid, CanonicalOutput> Greet.DataStructureV3.ResultsStorage.CanonicalProcess.OutputsResults = new Dictionary<Guid, CanonicalOutput>()

Stores the results for each output by taking all the inputs amounts balanced to the respective outputs amounts or using allocation methods. Displaced outputs are not represented in this collection as they are not usable in downstream processes. Indexes are the resource ID associated to the upstrams at this point. For outputs all enems are balanced.

Property Documentation

Guid Greet.DataStructureV3.ResultsStorage.CanonicalProcess.VertexId
getset

Vertex ID associated with that process reference in the pathway


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