Greet 2014
Documentation for the GREET 2014 API
 All Classes Namespaces Functions Variables Enumerations Properties Events
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
Greet.UnitLib2.BaseQuantity Class Referenceabstract
Inheritance diagram for Greet.UnitLib2.BaseQuantity:
Greet.UnitLib2.DerivedQuantity Greet.UnitLib2.Quantity

Public Member Functions

double ConvertFromSI (int to_unit_index, double value)
 Converts the value to value in SI units, given the index of the Unit as ddefined in the associated list More...
 
double ConvertToSI (int from_unit_index, double value)
 Converts the value to value in SI units, given the index of the Unit as ddefined in the associated list More...
 
abstract XmlNode ToXML (XmlDocument doc)
 

Protected Member Functions

 BaseQuantity (XmlNode node)
 

Protected Attributes

uint dim
 
string name
 
int preferred_unit
 
string symbol
 
List< Unit > units
 

Properties

abstract uint Dim [get]
 Basic dimensions of the quantity represented in a single integer, use Dimension.Dimension to calculate the integer More...
 
abstract string Name [get]
 Name of the quantity, for example "energy" or "mass density" More...
 
abstract int Preffered_unit [get]
 Refers to index in Units list. To be used to display the quantity in GUi/Reports. More...
 
abstract Unit Si_unit [get]
 The default unit for the quantity More...
 
abstract string Symbol [get, set]
 Common SI symbol used for the quantity, for example L fro length, E for energy, $ for currency, Rho for mass density,... More...
 
abstract List< Unit > Units [get]
 List of all of the units defined for the quantity More...
 

Member Function Documentation

double Greet.UnitLib2.BaseQuantity.ConvertFromSI ( int  to_unit_index,
double  value 
)

Converts the value to value in SI units, given the index of the Unit as ddefined in the associated list

Parameters
to_unit_indexIndex of the Unit from which to be converted
valuevalue in the non-SI unnits
Returns
double Greet.UnitLib2.BaseQuantity.ConvertToSI ( int  from_unit_index,
double  value 
)

Converts the value to value in SI units, given the index of the Unit as ddefined in the associated list

Parameters
from_unit_indexIndex of the Unit from which to be converted
valuevalue in the non-SI unnits
Returns

Property Documentation

abstract uint Greet.UnitLib2.BaseQuantity.Dim
get

Basic dimensions of the quantity represented in a single integer, use Dimension.Dimension to calculate the integer

abstract string Greet.UnitLib2.BaseQuantity.Name
get

Name of the quantity, for example "energy" or "mass density"

abstract int Greet.UnitLib2.BaseQuantity.Preffered_unit
get

Refers to index in Units list. To be used to display the quantity in GUi/Reports.

abstract Unit Greet.UnitLib2.BaseQuantity.Si_unit
get

The default unit for the quantity

abstract string Greet.UnitLib2.BaseQuantity.Symbol
getset

Common SI symbol used for the quantity, for example L fro length, E for energy, $ for currency, Rho for mass density,...

abstract List<Unit> Greet.UnitLib2.BaseQuantity.Units
get

List of all of the units defined for the quantity

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