Inheritance diagram for Greet.DataStructureV3.Entities.AProcess:

Public Member Functions
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...

abstract bool	CheckSpecificIntegrity (GData data, bool showIds, bool fixFixableIssues, out string errorMessage)
	Checks the integrity of the process More...

virtual void	FromXmlNode (GData data, XmlNode node, string optionalParamPrefix)
	Reads the content of the node to populate the members of this AProcess instance 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...

abstract XmlNode	ToXmlNode (XmlDocument processDoc)
	Method to save the process to Xml. More...

Protected Member Functions
	AProcess ()
	General Constructors More...

Protected Attributes
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...

Properties
Dictionary< Guid, Dictionary < Guid, double > >	CarbonTransMatrix `[get, set]`

List< Input >	Converted_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< IIO >	FlattenAllocatedOutputList `[get]`
	Returns as list of all allocated outputs (main output and allocated co-products) More...

abstract List< IInput >	FlattenInputList `[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< IInput >	FlattenInputList `[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.IHaveMetadata
string	ModifiedBy `[get, set]`
	User that modified this entity the latest time More...

string	ModifiedOn `[get, set]`
	Time at which this was modified for the last time More...

string	Notes `[get, set]`
	Notes associated with that entity More...

Constructor & Destructor Documentation

Greet.DataStructureV3.Entities.AProcess.AProcess ( )

protected

General Constructors

Member Function Documentation

bool Greet.DataStructureV3.Entities.AProcess.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)

Parameters

showMoreInfo
showIds
fixFixableIssues	If set to true, some issues will be automatically fixed
msg	String used to add various messages if errors are detected

Returns: True if this process can be handled by the software false otherwise

abstract bool Greet.DataStructureV3.Entities.AProcess.CheckSpecificIntegrity	(	GData	data,
		bool	showIds,
		bool	fixFixableIssues,
		out string	errorMessage
	)

pure virtual

Checks the integrity of the process

Parameters

data	Data for checking references
showIds	True: To return detailed information about the errors
fixFixableIssues	If set to true some issues will be fixed automatically
errorMessage	Error message filled up with human readable issues and fixes

Returns

Implemented in Greet.DataStructureV3.Entities.TransportationProcess, and Greet.DataStructureV3.Entities.StationaryProcess.

virtual void Greet.DataStructureV3.Entities.AProcess.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 in Greet.DataStructureV3.Entities.TransportationProcess, and Greet.DataStructureV3.Entities.StationaryProcess.

bool Greet.DataStructureV3.Entities.AProcess.HasInputFromWell ( int resource_id )

Checks if the resource can come from a well and returns

Parameters

resource_id resource Id

Returns: True: if resource is coming from Well else False

override string Greet.DataStructureV3.Entities.AProcess.ToString ( )

Override method to return the Name of the process.

Returns

abstract XmlNode Greet.DataStructureV3.Entities.AProcess.ToXmlNode ( XmlDocument processDoc )

pure virtual

Method to save the process to Xml.

Parameters

processDoc XML Document

Returns: Xml Node with the process information

Implements Greet.DataStructureV3.Interfaces.IXmlObj.

Implemented in Greet.DataStructureV3.Entities.TransportationProcess, and Greet.DataStructureV3.Entities.StationaryProcess.

Member Data Documentation

int Greet.DataStructureV3.Entities.AProcess.id

protected

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

string Greet.DataStructureV3.Entities.AProcess.name

protected

Process name //latex Name

string Greet.DataStructureV3.Entities.AProcess.notes

protected

Process Notes

Property Documentation

Dictionary<Guid, Dictionary<Guid, double> > Greet.DataStructureV3.Entities.AProcess.CarbonTransMatrix

getset

The transfert matrix is used to know which inputs are propagated into which outputs.

It is a way to know the main input but also to associate an input with the co products, mostly used to trace biogenic carbon when burned into technologies

Used by indexing in this specific order : [OutputId][InputId]

List<Input> Greet.DataStructureV3.Entities.AProcess.Converted_inputs_for_aprocess_calculations

getset

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.

List<int> Greet.DataStructureV3.Entities.AProcess.CoProductIds

get

This should be renamed CoProductsResourcesIds

CoProductsElements Greet.DataStructureV3.Entities.AProcess.CoProducts

getset

List of all the Co-Products.

List<IIO> Greet.DataStructureV3.Entities.AProcess.FlattenAllocatedOutputList

get

Returns as list of all allocated outputs (main output and allocated co-products)

abstract List<IInput> Greet.DataStructureV3.Entities.AProcess.FlattenInputList

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

FunctionalUnitPreference Greet.DataStructureV3.Entities.AProcess.GetUnitPreference

get

Returns the unit preference for this AProcess

abstract int Greet.DataStructureV3.Entities.AProcess.Id

getset

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

MainOutput Greet.DataStructureV3.Entities.AProcess.MainOutput

getset

Main Output of the Process

int Greet.DataStructureV3.Entities.AProcess.MainOutputResourceID

get

Returns the main output material id for this process

string Greet.DataStructureV3.Entities.AProcess.Name

getset

Name of the process

string Greet.DataStructureV3.Entities.AProcess.Notes

getset

Process Notes

ProcessStaticEmissions Greet.DataStructureV3.Entities.AProcess.OtherStaticEmissions

getset

Other Emissions of the process

EmissionAmounts Greet.DataStructureV3.Entities.AProcess.OtherStaticEmissionsCalculatedAndNotSaved

getset

Static Emissions are calculated on the fly but does not need to be save in XML Data files.

string Greet.DataStructureV3.Entities.AProcess.PictureName

getset

Picture Name

string Greet.DataStructureV3.Entities.AProcess.Type

get

Returns the type of the Process. Stationary or Transportation.

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

C:/Users/ddieffenthaler/Desktop/SVN/source/greet-dev/main/DataManagement/DataStructureV3/DataV3/Entities/Process/abstract/AProcess.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation