Greet 2014
Documentation for the GREET 2014 API
 All Classes Namespaces Functions Variables Enumerations Properties Events
Public Member Functions | Properties | List of all members
Greet.DataStructureV3.Interfaces.IResource Interface Reference

The resource object contains the physical property and the name of a resource More...

Inheritance diagram for Greet.DataStructureV3.Interfaces.IResource:
Greet.DataStructureV3.Interfaces.IXmlObj Greet.DataStructureV3.Entities.ResourceData

Public Member Functions

IValue ConvertTo (string unit_name, IValue value)
 Converts a result value in a certain unit into another result value in the desired unit More...
 
IValue ConvertTo (string unit_name, IParameter value)
 Converts a parameter value in a certain unit into another result value in the desired unit The GREET value or USER value will be used depending on the UseOriginal attribute of the IParameter More...
 
- Public Member Functions inherited from Greet.DataStructureV3.Interfaces.IXmlObj
void FromXmlNode (IData data, XmlNode node)
 
XmlNode ToXmlNode (XmlDocument xmlDoc)
 

Properties

IParameter CarbonRatio [get, set]
 The Carbon ratio of the resource More...
 
List< int > CompatibilityIds [get, set]
 List of compatible resource Ids More...
 
IParameter Density [get, set]
 The Density of the resource More...
 
List< IEvaporatedGas > EvaporatedGasess [get, set]
 List of all the gases that the resource evaporates into More...
 
IParameter HigherHeatingValue [get, set]
 The Low Heating Value of the resource More...
 
int Id [get, set]
 Unique ID for this resource among the resources More...
 
IParameter LowerHeatingValue [get, set]
 The Hight Heating Value of the resource More...
 
List< int > Memberships [get, set]
 Lists the memberships of that gas More...
 
string Name [get, set]
 Name for this resource as it is going to show on the graphical interface More...
 
string PictureName [get, set]
 Image Name that represents the resource More...
 
IParameter SulfurRatio [get]
 The Sulfur ratio of the resource More...
 

Detailed Description

The resource object contains the physical property and the name of a resource

Member Function Documentation

IValue Greet.DataStructureV3.Interfaces.IResource.ConvertTo ( string  unit_name,
IValue  value 
)

Converts a result value in a certain unit into another result value in the desired unit

Parameters
unit_nameThe desired unit
valueValue to be converted
Returns
Converted value in desired unit

Implemented in Greet.DataStructureV3.Entities.ResourceData.

IValue Greet.DataStructureV3.Interfaces.IResource.ConvertTo ( string  unit_name,
IParameter  value 
)

Converts a parameter value in a certain unit into another result value in the desired unit The GREET value or USER value will be used depending on the UseOriginal attribute of the IParameter

Parameters
unit_nameThe desired unit
valueValue to be converted
Returns
Converted value in desired unit

Implemented in Greet.DataStructureV3.Entities.ResourceData.

Property Documentation

IParameter Greet.DataStructureV3.Interfaces.IResource.CarbonRatio
getset

The Carbon ratio of the resource

List<int> Greet.DataStructureV3.Interfaces.IResource.CompatibilityIds
getset

List of compatible resource Ids

IParameter Greet.DataStructureV3.Interfaces.IResource.Density
getset

The Density of the resource

List<IEvaporatedGas> Greet.DataStructureV3.Interfaces.IResource.EvaporatedGasess
getset

List of all the gases that the resource evaporates into

IParameter Greet.DataStructureV3.Interfaces.IResource.HigherHeatingValue
getset

The Low Heating Value of the resource

int Greet.DataStructureV3.Interfaces.IResource.Id
getset

Unique ID for this resource among the resources

IParameter Greet.DataStructureV3.Interfaces.IResource.LowerHeatingValue
getset

The Hight Heating Value of the resource

List<int> Greet.DataStructureV3.Interfaces.IResource.Memberships
getset

Lists the memberships of that gas

string Greet.DataStructureV3.Interfaces.IResource.Name
getset

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

string Greet.DataStructureV3.Interfaces.IResource.PictureName
getset

Image Name that represents the resource

IParameter Greet.DataStructureV3.Interfaces.IResource.SulfurRatio
get

The Sulfur ratio of the resource

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