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

A transportation process in GREET, contains an architecture of steps which define the transportation and how modes are used the fuel share for each modes are defined in the TransportationFuelShares More...

Inheritance diagram for Greet.DataStructureV3.Entities.TransportationProcess:
Greet.DataStructureV3.Entities.AProcess Greet.DataStructureV3.Entities.IHaveAPicture Greet.DataStructureV3.Interfaces.ITransportationProcess Greet.DataStructureV3.Interfaces.IProcess Greet.DataStructureV3.IHaveMetadata Greet.DataStructureV3.Interfaces.IXmlObj

Public Member Functions

 TransportationProcess (GData data)
 
 TransportationProcess (GData data, XmlNode node, string optionalPramaPrefix)
 
double CalculateStorageDuration (GData data)
 Calculate the storage duration in seconds depending of the steps distances and average speeds for this transportation process More...
 
override bool CheckSpecificIntegrity (GData data, bool showIds, bool fixFixableIssues, out string errorMessage)
 Checks the integrity of a transportation process More...
 
override void FromXmlNode (GData data, XmlNode node, string optionalParamPrefix)
 Reads the content of the node to populate the members of this AProcess instance More...
 
void RecursiveSearch (GData data, IEnumerable< TransportationStep > structure, XmlNode node, string optionalParamPrefix)
 This method fill is the transportationOrganization parameter by recursevlely reading the structure from the transportation process XmlNode More...
 
override XmlNode ToXmlNode (XmlDocument doc)
 Method to save the process to Xml. More...
 
bool UsesFuelShare (int mode_id, int fuel_share_ref)
 
bool UsesMode (int mode_id)
 This method checks if the any of the steps of the transportation process uses mode with id = mode_id More...
 
- Public Member Functions inherited from Greet.DataStructureV3.Entities.AProcess
bool CheckIntegrity (GData data, bool showIds, bool fixFixableIssues, out string msg)
 This function checks wheather both main input and main output were assigned. It needs to be done after ConvertToGeneralInOut is called. Well main input can be null for a few processes so we don't need to check it (david) More...
 
void FromXmlNode (IData data, XmlNode node)
 
bool HasInputFromWell (int resource_id)
 Checks if the resource can come from a well and returns More...
 
override string ToString ()
 Override method to return the Name of the process. More...
 
- Public Member Functions inherited from Greet.DataStructureV3.Entities.IDurationProcess
double CalculateStorageDuration (GData data)
 

Public Attributes

Input MainInput = new Input()
 

Properties

override List< IInputFlattenInputList [get]
 
override int Id [get, set]
 
Parameter MainOutputMoistureContent [get, set]
 
new string Notes [get, set]
 
List< ITransportationStepSteps [get]
 
Dictionary< Guid,
TransportationStep
TransportationSteps [get, set]
 
- Properties inherited from Greet.DataStructureV3.Entities.AProcess
Dictionary< Guid, Dictionary
< Guid, double > > 
CarbonTransMatrix [get, set]
 
List< InputConverted_inputs_for_aprocess_calculations [get, set]
 List of all inputs of the process. In stationary process. It contains both the indivdual inputs and group inputs. In Transportation process. It contains all the steps which are converted as inputs. More...
 
List< int > CoProductIds [get]
 This should be renamed CoProductsResourcesIds More...
 
CoProductsElements CoProducts [get, set]
 List of all the Co-Products. More...
 
List< IIOFlattenAllocatedOutputList [get]
 Returns as list of all allocated outputs (main output and allocated co-products) More...
 
abstract List< IInputFlattenInputList [get]
 This methods flattens all the available inputs from a process without doing any calculations or operations on the process Warning for transportation processes, it only returns the MainOutput amount in a new MainInputObject as the others are dependent on the Modes and Transportation Steps and Process Fuels used for each step More...
 
FunctionalUnitPreference GetUnitPreference [get]
 Returns the unit preference for this AProcess More...
 
abstract int Id [get, set]
 Unique Process ID, this accessor is abstract because changing the ID of a stationary process needs some processing done to the children members of the process. This processing is done in the accessors of the clas More...
 
MainOutput MainOutput [get, set]
 Main Output of the Process More...
 
int MainOutputResourceID [get]
 Returns the main output material id for this process More...
 
string ModifiedBy [get, set]
 
string ModifiedOn [get, set]
 
string Name [get, set]
 Name of the process More...
 
string Notes [get, set]
 Process Notes More...
 
ProcessStaticEmissions OtherStaticEmissions [get, set]
 Other Emissions of the process More...
 
EmissionAmounts OtherStaticEmissionsCalculatedAndNotSaved [get, set]
 Static Emissions are calculated on the fly but does not need to be save in XML Data files. More...
 
List< int > OutputEmissionsIds [get]
 
string PictureName [get, set]
 Picture Name More...
 
string Type [get]
 Returns the type of the Process. Stationary or Transportation. More...
 
- Properties inherited from Greet.DataStructureV3.Entities.IGraphRepresented
string Name [get, set]
 
string Notes [get, set]
 
string PictureName [get, set]
 
- Properties inherited from Greet.DataStructureV3.Interfaces.IProcess
List< int > CoProductIds [get]
 Returns the list of Co-Product resource id's More...
 
List< IInputFlattenInputList [get]
 Returns a flatten list of all the inputs in a process. Includes inputs from Group and individual inputs. More...
 
int Id [get, set]
 Unique ID for this vprocess among the processes More...
 
int MainOutputResourceID [get]
 Returns the Resource Id of the Main output of the process More...
 
string Name [get, set]
 Name for this process as it is going to show on the graphical interface More...
 
List< int > OutputEmissionsIds [get]
 Returns the list of all the output emissions of the process More...
 
- Properties inherited from Greet.DataStructureV3.Entities.IHaveAPicture
string PictureName [get, set]
 Get or Set the image name of the object More...
 
- Properties inherited from Greet.DataStructureV3.Interfaces.ITransportationProcess
List< ITransportationStepSteps [get]
 List of steps in transporation process More...
 

Additional Inherited Members

- Protected Member Functions inherited from Greet.DataStructureV3.Entities.AProcess
 AProcess ()
 General Constructors More...
 
- Protected Attributes inherited from Greet.DataStructureV3.Entities.AProcess
int id
 Do not use this as a public accessor, when the ID is changed, all the references to the parent process id for the transportation steps needs to be updated This is going to be done in the accessors of the transportation process Id More...
 
string name
 Process name //latex Name More...
 
string notes
 Process Notes More...
 

Detailed Description

A transportation process in GREET, contains an architecture of steps which define the transportation and how modes are used the fuel share for each modes are defined in the TransportationFuelShares

Member Function Documentation

double Greet.DataStructureV3.Entities.TransportationProcess.CalculateStorageDuration ( GData  data)

Calculate the storage duration in seconds depending of the steps distances and average speeds for this transportation process

Returns
override bool Greet.DataStructureV3.Entities.TransportationProcess.CheckSpecificIntegrity ( GData  data,
bool  showIds,
bool  fixFixableIssues,
out string  errorMessage 
)
virtual

Checks the integrity of a transportation process

Parameters
dataDatabase used to test constraints such as resource ids, processes upstreams
showIds
fixFixableIssues
errorMessage
Returns
True if Valid

Implements Greet.DataStructureV3.Entities.AProcess.

override void Greet.DataStructureV3.Entities.TransportationProcess.FromXmlNode ( GData  data,
XmlNode  node,
string  optionalParamPrefix 
)
virtual

Reads the content of the node to populate the members of this AProcess instance

Parameters
node

Reimplemented from Greet.DataStructureV3.Entities.AProcess.

void Greet.DataStructureV3.Entities.TransportationProcess.RecursiveSearch ( GData  data,
IEnumerable< TransportationStep structure,
XmlNode  node,
string  optionalParamPrefix 
)

This method fill is the transportationOrganization parameter by recursevlely reading the structure from the transportation process XmlNode

Parameters
structure
node
override XmlNode Greet.DataStructureV3.Entities.TransportationProcess.ToXmlNode ( XmlDocument  processDoc)
virtual

Method to save the process to Xml.

Parameters
processDocXML Document
Returns
Xml Node with the process information

Implements Greet.DataStructureV3.Entities.AProcess.

bool Greet.DataStructureV3.Entities.TransportationProcess.UsesMode ( int  mode_id)

This method checks if the any of the steps of the transportation process uses mode with id = mode_id

Parameters
mode_idId of a transportation mode
Returns

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