Greet 2014
Documentation for the GREET 2014 API
 All Classes Namespaces Functions Variables Enumerations Properties Events
Greet.UnitLib.Quantity Class Reference

Extends BaseQuantity by including the default and override units and conversion methods between units More...

Inheritance diagram for Greet.UnitLib.Quantity:
Greet.UnitLib.BaseQuantity Greet.UnitLib.IQuantity

Public Member Functions

 Quantity (XmlNode node)
 
 Quantity (string name, string displayName, string format, string defaultUnit, string overrideUnit)
 
override double ConvertFromDefaultToOverride (double valueToConvert)
 Conversion from default unit of the group (not necessarily SI) to override unit of the group More...
 
override double ConvertFromDefaultToSpecific (double valueToConvert, string unit)
 Conversion from default unit of the group (not necesseraly SI) to a different unit of the same group More...
 
override double ConvertFromOverrideToDefault (double valueToConvert)
 Conversion from override to default unit of the group (not necesseraly SI) More...
 
- Public Member Functions inherited from Greet.UnitLib.BaseQuantity
bool DefaultOnlyEquals (BaseQuantity obj)
 
override bool Equals (object obj)
 
override int GetHashCode ()
 
virtual void OnEvent ()
 
override string ToString ()
 
delegate void UnitChangedDelegate ()
 

Public Attributes

List< string > MemberUnits = new List<string>()
 
- Public Attributes inherited from Greet.UnitLib.BaseQuantity
string format = ""
 Used to visualize parameters of this group with the number of significant digits specified. This attribute is used with ToString methods. Possible value=0.000 More...
 
UnitChangedDelegate UnitChanged
 Occurs when the overrideUnit changes. More...
 

Properties

override string Abbrev [get]
 
Unit DefaultUnit [get, set]
 
override string DefaultUnitAbbrev [get]
 
override string DisplayUnitStr [get]
 
Unit OverrideUnit [get, set]
 
override string SIUnitStr [get]
 
- Properties inherited from Greet.UnitLib.BaseQuantity
abstract string Abbrev [get]
 
abstract string DefaultUnitAbbrev [get]
 
string DisplayName [get, set]
 
abstract string DisplayUnitStr [get]
 
string Name [get, set]
 
abstract string SIUnitStr [get]
 
UnitChangedDelegate UnitChangedEvent
 
- Properties inherited from Greet.UnitLib.IQuantity
string DisplayUnitStr [get]
 The prefered unit used for this group in order to represent a value on the user interface More...
 
string Name [get]
 Unique name of the unit group More...
 
string SIUnitStr [get]
 The default unit used for this group in SI unit. This is the unit that is used across the calculations More...
 

Additional Inherited Members

- Protected Member Functions inherited from Greet.UnitLib.BaseQuantity
 BaseQuantity (XmlNode node)
 

Detailed Description

Extends BaseQuantity by including the default and override units and conversion methods between units

Member Function Documentation

override double Greet.UnitLib.Quantity.ConvertFromDefaultToOverride ( double  valueToConvert)
virtual

Conversion from default unit of the group (not necessarily SI) to override unit of the group

Parameters
valueToConvertquantity assumed to be in default units
Returns
Value in the override unit of the group

Implements Greet.UnitLib.BaseQuantity.

override double Greet.UnitLib.Quantity.ConvertFromDefaultToSpecific ( double  valueToConvert,
string  unit 
)
virtual

Conversion from default unit of the group (not necesseraly SI) to a different unit of the same group

Parameters
valueToConvertquantity assumed to be in default units
unitname of the unit to convert to
Returns
Value in the unit specified

Implements Greet.UnitLib.BaseQuantity.

override double Greet.UnitLib.Quantity.ConvertFromOverrideToDefault ( double  valueToConvert)
virtual

Conversion from override to default unit of the group (not necesseraly SI)

Parameters
valueToConvertquantity assumed to be in override units
Returns
Value in the default unit of the group

Implements Greet.UnitLib.BaseQuantity.


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