GREET API
Exposed interfaces to create modules that can be loaded in GREET
 All Classes Namespaces Files Functions Enumerations Enumerator Properties Events
PlugInsInterfaces.DataTypes.Resource.IResource Interface Reference

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

Inheritance diagram for PlugInsInterfaces.DataTypes.Resource.IResource:
Collaboration diagram for PlugInsInterfaces.DataTypes.Resource.IResource:

Public Member Functions

IResultValue ConvertTo (string unit_name, IResultValue value)
 Converts a result value in a certain unit into another result value in the desired unit More...
 
IResultValue 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 PlugInsInterfaces.DataTypes.IXmlObj
XmlNode ToXmlNode (XmlDocument xmlDoc)
 
void FromXmlNode (IData data, XmlNode node)
 

Properties

string Name [get, set]
 Name for this resource as it is going to show on the graphical interface More...
 
int Id [get, set]
 Unique ID for this resource among the resources More...
 
List< IEvaporatedGasEvaporatedGasess [get, set]
 List of all the gases that the resource evaporates into More...
 
IParameter SRatioo [get]
 The Sulfur ratio of the resource More...
 
IParameter CRatioo [get, set]
 The Carbon ratio of the resource More...
 
IParameter Densityy [get, set]
 The Density of the resource More...
 
IParameter HHV [get, set]
 The Low Heating Value of the resource More...
 
IParameter LHV [get, set]
 The Hight Heating Value of the resource More...
 
List< int > CompatibilityIds [get, set]
 List of compatible resource Ids More...
 
string PictureName [get, set]
 Image Name that represents the resource More...
 

Detailed Description

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

Definition at line 14 of file IResource.cs.

Member Function Documentation

IResultValue PlugInsInterfaces.DataTypes.Resource.IResource.ConvertTo ( string  unit_name,
IResultValue  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
IResultValue PlugInsInterfaces.DataTypes.Resource.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

Property Documentation

List<int> PlugInsInterfaces.DataTypes.Resource.IResource.CompatibilityIds
getset

List of compatible resource Ids

Definition at line 61 of file IResource.cs.

IParameter PlugInsInterfaces.DataTypes.Resource.IResource.CRatioo
getset

The Carbon ratio of the resource

Definition at line 40 of file IResource.cs.

IParameter PlugInsInterfaces.DataTypes.Resource.IResource.Densityy
getset

The Density of the resource

Definition at line 45 of file IResource.cs.

List<IEvaporatedGas> PlugInsInterfaces.DataTypes.Resource.IResource.EvaporatedGasess
getset

List of all the gases that the resource evaporates into

Definition at line 30 of file IResource.cs.

IParameter PlugInsInterfaces.DataTypes.Resource.IResource.HHV
getset

The Low Heating Value of the resource

Definition at line 50 of file IResource.cs.

int PlugInsInterfaces.DataTypes.Resource.IResource.Id
getset

Unique ID for this resource among the resources

Definition at line 25 of file IResource.cs.

IParameter PlugInsInterfaces.DataTypes.Resource.IResource.LHV
getset

The Hight Heating Value of the resource

Definition at line 55 of file IResource.cs.

string PlugInsInterfaces.DataTypes.Resource.IResource.Name
getset

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

Definition at line 20 of file IResource.cs.

string PlugInsInterfaces.DataTypes.Resource.IResource.PictureName
getset

Image Name that represents the resource

Definition at line 67 of file IResource.cs.

IParameter PlugInsInterfaces.DataTypes.Resource.IResource.SRatioo
get

The Sulfur ratio of the resource

Definition at line 35 of file IResource.cs.


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