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

This struct is used to store a reference to a gas ID for the calculation balance purposes More...

Public Member Functions

 GasBalanceReference (supportedBalanceTypes type, int reference, string notes, List< int > parameters=null)
 General constructor, creates the struct and initialize all memembers More...
 

Public Attributes

int _gasRef
 The reference to the gas that is being balance More...
 
string _notes
 Notes to remember what is that gas reference about More...
 
List< int > _parameters
 A list of parameters for the balance, can be ids to substract or add, or null More...
 
supportedBalanceTypes _type
 The type of balance for which this gas reference is stored More...
 

Properties

int GasRef [get, set]
 The gas ID that is used for the balance More...
 
string Notes [get, set]
 Notes to remember what is that gas reference about More...
 
List< int > Parameters [get, set]
 
supportedBalanceTypes Type [get, set]
 The type of balance that is done for that stored gas ID More...
 

Detailed Description

This struct is used to store a reference to a gas ID for the calculation balance purposes

Constructor & Destructor Documentation

Greet.DataStructureV3.Entities.GasBalanceReference.GasBalanceReference ( supportedBalanceTypes  type,
int  reference,
string  notes,
List< int >  parameters = null 
)

General constructor, creates the struct and initialize all memembers

Parameters
typeThe type of balance that is done for that stored gas ID
referenceThe gas ID that is used for the balance
notesNotes to remember what is that gas reference about
parametersCan represent a list of other gases IDs to use as parameters

Member Data Documentation

int Greet.DataStructureV3.Entities.GasBalanceReference._gasRef

The reference to the gas that is being balance

string Greet.DataStructureV3.Entities.GasBalanceReference._notes

Notes to remember what is that gas reference about

List<int> Greet.DataStructureV3.Entities.GasBalanceReference._parameters

A list of parameters for the balance, can be ids to substract or add, or null

supportedBalanceTypes Greet.DataStructureV3.Entities.GasBalanceReference._type

The type of balance for which this gas reference is stored

Property Documentation

int Greet.DataStructureV3.Entities.GasBalanceReference.GasRef
getset

The gas ID that is used for the balance

string Greet.DataStructureV3.Entities.GasBalanceReference.Notes
getset

Notes to remember what is that gas reference about

List<int> Greet.DataStructureV3.Entities.GasBalanceReference.Parameters
getset

supportedBalanceTypes Greet.DataStructureV3.Entities.GasBalanceReference.Type
getset

The type of balance that is done for that stored gas ID


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