Greet 2014
Documentation for the GREET 2014 API
 All Classes Namespaces Functions Variables Enumerations Properties Events
Greet.DataStructureV3.Entities.VehicleOperationalMode Class Referenceabstract

Represent a operational mode for a defined vehicle The class is abstract and could be either CD or CS mode More...

Inheritance diagram for Greet.DataStructureV3.Entities.VehicleOperationalMode:
Greet.DataStructureV3.Interfaces.IVehicleMode Greet.DataStructureV3.Entities.CDMode Greet.DataStructureV3.Entities.RegularMode

Public Member Functions

virtual void AddNewYear (GData data, double year, bool baseMpg, bool baseEmission)
 
List< VehicleFuelFuelBlend (Vehicles vehicles)
 Returns all the fuels used by the vehicle in this mode. It includes the fuels from the Base vehicle also. More...
 
string ModeType ()
 Returns the mode of the current object. More...
 
IResults PumpToWheelsResults (IData data)
 Return the emissions associated to that mode per joule of fuel used More...
 
IResults WellToPumpResults (IData data)
 The upstream per joule of energy used More...
 

Public Attributes

string _errorMessages = ""
 
EmissionAmounts _fuelEmissions
 
EmissionAmounts _fuelEmissionsUrban
 
ResourceAmounts _fuelEnergy
 Resources used for fuel production per meter for this mode(PTW results per meter) More...
 
bool _operationCorrectlyCalculated
 
EmissionAmounts _operationEmissions
 
EmissionAmounts _operationEmissionsUrban
 
ResourceAmounts _operationEnergy
 Resources used for the operation of the vehicle for this mode without includung any upstream (WTP results per meter) More...
 
VehicleOperatingModeEmissionsTSData _technologies
 The emission factors for the vehicle usually expressed in kilograms per meter a different set of emission factors is selected for each year. More...
 
EmissionAmounts _totalEmissions
 
EmissionAmounts _totalEmissionsUrban
 
ResourceAmounts _totalEnergy
 Resources used for the operation and the fuel production for this mode (WTW results per meter) More...
 
bool _upstreamCorrectlyCalculated
 
bool _usesBaseFuelShares
 
double _utilityFactor
 If multiple modes are used and we are calculating modes of a plugin hybrid electric vehicle The utility factor is calculated using a polynom which takes as a parameter the full electric range of the vehicle and tells us what percentage of the time the vehicle is running on CD mode. More...
 
int _vehicleReferenceId
 

Protected Member Functions

 VehicleOperationalMode (int vehicle_reference)
 
 VehicleOperationalMode (GData data, XmlNode xmlNode, int vehicle_reference, string optionalParamPrefix)
 

Protected Attributes

int _mpggeRef = 24
 Holds a integer that represents the resource used for calculating the mpgge value this resource physical properties are going to be used for the conversions. Usually this will be Conventional Gasoline More...
 

Properties

IProductionItem CDElectrictyUsed [get]
 
EmissionAmounts FuelEmissions [get]
 Return emissions associated with fuel production More...
 
EmissionAmounts FuelEmissionsUrban [get]
 Return urban emissions associated with fuel production More...
 
ResourceAmounts FuelEnergy [get]
 Return energy associated with fuel production More...
 
Dictionary
< IInputResourceReference,
double > 
FuelsUsed [get]
 Returns the fuels used by this vehicle as a List of Source(IInputResourceReference) and its share. Used primarly to return the Fuels in terms of Interface objects. More...
 
List< VehicleFuelFuelsUsedWithoutBaseFuels [get, set]
 Returns the fuels used by the vehicle in this mode. It does not include the fuels from the base vehicle. More...
 
MPGsTS Mpg [get, set]
 The mpg time series More...
 
string Name [get, set]
 
EmissionAmounts OperationEmissions [get]
 Return emissions associated with vehicle operation More...
 
EmissionAmounts OperationEmissionsUrban [get]
 Return urban emissions associated with vehicle operation More...
 
ResourceAmounts OperationEnergy [get]
 Return energy associated with vehicle operation More...
 
VehicleOperatingModeEmissionsTSData Technologies [get, set]
 the emission factors time series More...
 
EmissionAmounts TotalEmissions [get]
 Return total emissions for the mode More...
 
EmissionAmounts TotalEmissionsUrban [get]
 Return total urban emissions for the mode More...
 
ResourceAmounts TotalEnergy [get]
 Return total energy for the mode More...
 
double UtilityFactor [get]
 Return utility factor which is calculated when CD mode is calculated More...
 
- Properties inherited from Greet.DataStructureV3.Interfaces.IVehicleMode
IProductionItem CDElectrictyUsed [get]
 
Dictionary
< IInputResourceReference,
double > 
FuelsUsed [get]
 Resources used and share for this mode More...
 
string Name [get]
 Name of the mode More...
 

Detailed Description

Represent a operational mode for a defined vehicle The class is abstract and could be either CD or CS mode

Member Function Documentation

List<VehicleFuel> Greet.DataStructureV3.Entities.VehicleOperationalMode.FuelBlend ( Vehicles  vehicles)

Returns all the fuels used by the vehicle in this mode. It includes the fuels from the Base vehicle also.

Parameters
vehicles
Returns
string Greet.DataStructureV3.Entities.VehicleOperationalMode.ModeType ( )

Returns the mode of the current object.

Returns
CDMode for CD Mode, RegularMode for regular mode
IResults Greet.DataStructureV3.Entities.VehicleOperationalMode.PumpToWheelsResults ( IData  data)

Return the emissions associated to that mode per joule of fuel used

Parameters
dataData which contains the vehicle
Returns
Results object with the results

Implements Greet.DataStructureV3.Interfaces.IVehicleMode.

IResults Greet.DataStructureV3.Entities.VehicleOperationalMode.WellToPumpResults ( IData  data)

The upstream per joule of energy used

Parameters
dataData which contains the vehicle
Returns
Results object with the results

Implements Greet.DataStructureV3.Interfaces.IVehicleMode.

Member Data Documentation

ResourceAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode._fuelEnergy

Resources used for fuel production per meter for this mode(PTW results per meter)

int Greet.DataStructureV3.Entities.VehicleOperationalMode._mpggeRef = 24
protected

Holds a integer that represents the resource used for calculating the mpgge value this resource physical properties are going to be used for the conversions. Usually this will be Conventional Gasoline

ResourceAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode._operationEnergy

Resources used for the operation of the vehicle for this mode without includung any upstream (WTP results per meter)

VehicleOperatingModeEmissionsTSData Greet.DataStructureV3.Entities.VehicleOperationalMode._technologies

The emission factors for the vehicle usually expressed in kilograms per meter a different set of emission factors is selected for each year.

ResourceAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode._totalEnergy

Resources used for the operation and the fuel production for this mode (WTW results per meter)

double Greet.DataStructureV3.Entities.VehicleOperationalMode._utilityFactor

If multiple modes are used and we are calculating modes of a plugin hybrid electric vehicle The utility factor is calculated using a polynom which takes as a parameter the full electric range of the vehicle and tells us what percentage of the time the vehicle is running on CD mode.

Property Documentation

EmissionAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode.FuelEmissions
get

Return emissions associated with fuel production

EmissionAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode.FuelEmissionsUrban
get

Return urban emissions associated with fuel production

ResourceAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode.FuelEnergy
get

Return energy associated with fuel production

Dictionary<IInputResourceReference, double> Greet.DataStructureV3.Entities.VehicleOperationalMode.FuelsUsed
get

Returns the fuels used by this vehicle as a List of Source(IInputResourceReference) and its share. Used primarly to return the Fuels in terms of Interface objects.

List<VehicleFuel> Greet.DataStructureV3.Entities.VehicleOperationalMode.FuelsUsedWithoutBaseFuels
getset

Returns the fuels used by the vehicle in this mode. It does not include the fuels from the base vehicle.

MPGsTS Greet.DataStructureV3.Entities.VehicleOperationalMode.Mpg
getset

The mpg time series

EmissionAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode.OperationEmissions
get

Return emissions associated with vehicle operation

EmissionAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode.OperationEmissionsUrban
get

Return urban emissions associated with vehicle operation

ResourceAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode.OperationEnergy
get

Return energy associated with vehicle operation

VehicleOperatingModeEmissionsTSData Greet.DataStructureV3.Entities.VehicleOperationalMode.Technologies
getset

the emission factors time series

EmissionAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode.TotalEmissions
get

Return total emissions for the mode

EmissionAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode.TotalEmissionsUrban
get

Return total urban emissions for the mode

ResourceAmounts Greet.DataStructureV3.Entities.VehicleOperationalMode.TotalEnergy
get

Return total energy for the mode

double Greet.DataStructureV3.Entities.VehicleOperationalMode.UtilityFactor
get

Return utility factor which is calculated when CD mode is calculated


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