Greet 2014
Documentation for the GREET 2014 API
 All Classes Namespaces Functions Variables Enumerations Properties Events
Greet.DataStructureV3.Interfaces.IPathway Interface Reference

More...

Inheritance diagram for Greet.DataStructureV3.Interfaces.IPathway:
Greet.DataStructureV3.Interfaces.IXmlObj Greet.DataStructureV3.Entities.Pathway

Public Member Functions

Dictionary< IIO, IResultsGetUpstreamResults (IData data)
 Upstream results associated to that pathway More...
 
- Public Member Functions inherited from Greet.DataStructureV3.Interfaces.IXmlObj
void FromXmlNode (IData data, XmlNode node)
 
XmlNode ToXmlNode (XmlDocument xmlDoc)
 

Properties

List< IEdgeEdges [get]
 Edges that represents connections in between the vertices inputs and outputs More...
 
int Id [get, set]
 Unique ID for this pathway among the pathways More...
 
Guid MainOutput [get, set]
 Each pathway must define one main output, especially usefull when the pathway has multiple outputs for the same resource ID This is used for simplification reasons, the user can chose a pathway as an upstream and the main intput will be automatically selected as the upstream associated with that pathway. Thus saving the user from chosing which outputs he desires. More...
 
int MainOutputResourceID [get]
 Returns the resource ID associated with the main output of the pathway. This accessor finds the Output for which the ID match the MainOutput guid and reutrns the resource defined for that output. Returns -1 if the main output cannot be found. More...
 
string Name [get, set]
 Name for this pathway as it is going to show on the graphical interface More...
 
List< IIOOutputs [get]
 
string PictureName [get, set]
 Picture for this pathway as it is going to show on the graphical interface More...
 
List< IProcessReferenceProcesses [get]
 Returns and ordered list of the process IDs used in this pathway More...
 
List< IVertexVertices [get]
 Vertices for that Pathway, vertices can hold a reference to a process, a pathway or a mix More...
 

Detailed Description

A pathway represents a flow of resources though processes in series. Each process is represented by a IProcessReference

In order to get the results, or upstream associated with the production of a resource from a pathway, the prefered way is to get the results associated with the last process reference in that pathway

Member Function Documentation

Dictionary<IIO, IResults> Greet.DataStructureV3.Interfaces.IPathway.GetUpstreamResults ( IData  data)

Upstream results associated to that pathway

This is the prefered way to get the upstream for a product from any pathway. This is equivalent of getting the upstream of the last process in this pathway

Parameters
dataData object needed for references
Returns
Dictionary containing the allocated results for each output of pathway

Implemented in Greet.DataStructureV3.Entities.Pathway.

Property Documentation

List<IEdge> Greet.DataStructureV3.Interfaces.IPathway.Edges
get

Edges that represents connections in between the vertices inputs and outputs

int Greet.DataStructureV3.Interfaces.IPathway.Id
getset

Unique ID for this pathway among the pathways

Guid Greet.DataStructureV3.Interfaces.IPathway.MainOutput
getset

Each pathway must define one main output, especially usefull when the pathway has multiple outputs for the same resource ID This is used for simplification reasons, the user can chose a pathway as an upstream and the main intput will be automatically selected as the upstream associated with that pathway. Thus saving the user from chosing which outputs he desires.

int Greet.DataStructureV3.Interfaces.IPathway.MainOutputResourceID
get

Returns the resource ID associated with the main output of the pathway. This accessor finds the Output for which the ID match the MainOutput guid and reutrns the resource defined for that output. Returns -1 if the main output cannot be found.

string Greet.DataStructureV3.Interfaces.IPathway.Name
getset

Name for this pathway as it is going to show on the graphical interface

List<IIO> Greet.DataStructureV3.Interfaces.IPathway.Outputs
get

Lists outputs that are proper to the pathway

This are not the outputs of the processes. The output of the processes are linked to these outputs using Edges but are not the same instances

string Greet.DataStructureV3.Interfaces.IPathway.PictureName
getset

Picture for this pathway as it is going to show on the graphical interface

List<IProcessReference> Greet.DataStructureV3.Interfaces.IPathway.Processes
get

Returns and ordered list of the process IDs used in this pathway

List<IVertex> Greet.DataStructureV3.Interfaces.IPathway.Vertices
get

Vertices for that Pathway, vertices can hold a reference to a process, a pathway or a mix


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