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

Store an object that is used for accounting the emissions associated with one specie in the model More...

Inheritance diagram for Greet.DataStructureV3.Entities.Gas:
Greet.DataStructureV3.Entities.IGroupAvailable Greet.DataStructureV3.Entities.IHaveAPicture Greet.DataStructureV3.Interfaces.IGas Greet.DataStructureV3.IHaveMetadata Greet.DataStructureV3.Interfaces.IXmlObj

Public Member Functions

 Gas (GData data)
 Default consturctor, creates a gas with new properties and an Id that is unique to the gases database. More...
 
 Gas (GData data, XmlNode gasNode)
 Creates a new object from an XML node. More...
 
void FromXmlNode (IData data, XmlNode node)
 
override string ToString ()
 Strings that represents this object, here only the name is returned More...
 
XmlNode ToXmlNode (XmlDocument xmlDocument)
 Creates an XML node object filled up with the data associated with that Gas object More...
 

Properties

IParameter Carbon_Ratio [get]
 Get or Sets the mass carbon ratio associated to that gas object More...
 
Parameter CarbonRatio [get, set]
 Get or Sets the mass carbon ratio associated to that gas object More...
 
Parameter GlobalWarmingPotential [get, set]
 Get or Set the global warming potential value for this gas relative to CO2 More...
 
int Id [get, set]
 Get or Sets the ID for this object The ID should be unique among the gases database More...
 
int IsChildOf [get]
 Returns the ID stored in the childOf of attribute More...
 
List< int > Memberships [get, set]
 Get or Set the list of memeberships that this gas is a member of More...
 
string ModifiedBy [get, set]
 
string ModifiedOn [get, set]
 
string Name [get, set]
 Gets or Sets the Name for this gas object More...
 
string Notes [get, set]
 Get or Set notes associated to the gas object More...
 
string PictureName [get, set]
 Get or Set the name of the picture associated to the gas object The picture name do not refer to a specific file, but to a picture name stored in the database images libraries More...
 
bool ShowInResults [get, set]
 Get or Set the show in results property for that object If true, the emissions will show this gas as a results, if false the emissions are still calculated but not shown in the GUI More...
 
IParameter Sulfur_Ratio [get]
 Get or Set the mass sulfur ratio associated with that gas object More...
 
Parameter SulfurRatio [get, set]
 Get or Set the mass sulfur ratio associated with that gas object More...
 
- Properties inherited from Greet.DataStructureV3.Entities.IGroupAvailable
int Id [get]
 The ID of the currently edited object More...
 
List< int > Memberships [get, set]
 Get or Set the list of memberships for that object 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.IGas
IParameter Carbon_Ratio [get]
 Carbon Ratio for that gas More...
 
double GlobalWarmingPotential [get]
 Global warming potential for that gas More...
 
int Id [get, set]
 Unique ID for the gas More...
 
List< int > Memberships [get, set]
 Lists the memberships of that gas More...
 
string Name [get, set]
 The name for this gas More...
 
IParameter Sulfur_Ratio [get]
 Sulphur Ratio for that gas More...
 

Detailed Description

Store an object that is used for accounting the emissions associated with one specie in the model

Constructor & Destructor Documentation

Greet.DataStructureV3.Entities.Gas.Gas ( GData  data)

Default consturctor, creates a gas with new properties and an Id that is unique to the gases database.

Greet.DataStructureV3.Entities.Gas.Gas ( GData  data,
XmlNode  gasNode 
)

Creates a new object from an XML node.

Parameters
gasNodeThe XML node representation of this object

Member Function Documentation

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

Strings that represents this object, here only the name is returned

Returns
XmlNode Greet.DataStructureV3.Entities.Gas.ToXmlNode ( XmlDocument  xmlDocument)

Creates an XML node object filled up with the data associated with that Gas object

Parameters
xmlDocumentXML Document object that will be used for the NamespaceURI
Returns
New XMLNode object that contains the data

Implements Greet.DataStructureV3.Interfaces.IXmlObj.

Property Documentation

IParameter Greet.DataStructureV3.Entities.Gas.Carbon_Ratio
get

Get or Sets the mass carbon ratio associated to that gas object

Parameter Greet.DataStructureV3.Entities.Gas.CarbonRatio
getset

Get or Sets the mass carbon ratio associated to that gas object

Parameter Greet.DataStructureV3.Entities.Gas.GlobalWarmingPotential
getset

Get or Set the global warming potential value for this gas relative to CO2

int Greet.DataStructureV3.Entities.Gas.Id
getset

Get or Sets the ID for this object The ID should be unique among the gases database

int Greet.DataStructureV3.Entities.Gas.IsChildOf
get

Returns the ID stored in the childOf of attribute

List<int> Greet.DataStructureV3.Entities.Gas.Memberships
getset

Get or Set the list of memeberships that this gas is a member of

string Greet.DataStructureV3.Entities.Gas.Name
getset

Gets or Sets the Name for this gas object

string Greet.DataStructureV3.Entities.Gas.Notes
getset

Get or Set notes associated to the gas object

string Greet.DataStructureV3.Entities.Gas.PictureName
getset

Get or Set the name of the picture associated to the gas object The picture name do not refer to a specific file, but to a picture name stored in the database images libraries

bool Greet.DataStructureV3.Entities.Gas.ShowInResults
getset

Get or Set the show in results property for that object If true, the emissions will show this gas as a results, if false the emissions are still calculated but not shown in the GUI

IParameter Greet.DataStructureV3.Entities.Gas.Sulfur_Ratio
get

Get or Set the mass sulfur ratio associated with that gas object

Parameter Greet.DataStructureV3.Entities.Gas.SulfurRatio
getset

Get or Set the mass sulfur ratio associated with that gas object


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