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

Stores the data associated with a vehicle, its properties and its modes More...

Inheritance diagram for Greet.DataStructureV3.Entities.Vehicle:
Greet.DataStructureV3.Entities.IHaveAPicture Greet.DataStructureV3.Interfaces.IVehicle Greet.DataStructureV3.IHaveMetadata Greet.DataStructureV3.Interfaces.IXmlObj

Public Member Functions

 Vehicle ()
 Default vehicle constructor More...
 
bool CheckIntegrity (GData data, bool showIds, out string errorMessage)
 
void FromXmlNode (IData data, XmlNode node)
 
void InitializeMinYearDefinition ()
 This method loops thought the modes and find the minimum year for which all the modes (emissions and energies consumptions) are defined The value is stored in the minYearDefinition attribute of a vehicle More...
 
override string ToString ()
 
XmlNode ToXmlNode (XmlDocument xmlDoc)
 
XmlNode ToXmlResultsNode (XmlDocument doc)
 

Public Attributes

Boolean _gridConnected
 Flag set to true if the vehicle is grid connected (we should try to avoid that and handle this situation from the Modes directly) More...
 
string _pictureName = Constants.EmptyPicture
 Picture name that can be used to represent the vehicle More...
 

Properties

bool AnyParameterChangedSinceLastCalculated [get, set]
 
int BaseEmissionVehicleId [get, set]
 The base vehicle for emissions More...
 
int BaseMpgVehicleId [get, set]
 The base vehicle for energy consumption More...
 
bool CalculatedOk [get, set]
 
bool CalulatedCorrectly [get]
 
Parameter ChargerEfficiency [get, set]
 
Parameter ElectricRange [get, set]
 
string ErrorMessages [get, set]
 
Boolean GridConnected [get, set]
 
int Id [get, set]
 
double MinYearDefinition [get, set]
 
Dictionary< string,
VehicleOperationalMode
Modes [get, set]
 
string ModifiedBy [get, set]
 
string ModifiedOn [get, set]
 
string Name [get, set]
 
string Notes [get, set]
 
Dictionary< string, IVehicleModeOperatingModes [get]
 
string PictureName [get, set]
 
EmissionAmounts TotalEmissions [get, set]
 
EmissionAmounts TotalEmissionsUrban [get, set]
 
ResourceAmounts TotalEnergy [get, set]
 
EmissionAmounts UpstreamFuelEmissions [get, set]
 
EmissionAmounts UpstreamFuelEmissionsUrban [get, set]
 
ResourceAmounts UpstreamFuelEnergy [get, set]
 
double UrbanShare [get, set]
 
Parameter UrbanShareDV [get, set]
 
EmissionAmounts VehicleOperationEmissions [get, set]
 
EmissionAmounts VehicleOperationEmissionsUrban [get, set]
 
ResourceAmounts VehicleOperationEnergy [get, set]
 
- Properties inherited from Greet.DataStructureV3.Entities.IHaveAPicture
string PictureName [get, set]
 Get or Set the image name of the object More...
 
- Properties inherited from Greet.DataStructureV3.Interfaces.IVehicle
int BaseEmissionVehicleId [get, set]
 The base vehicle for emissions More...
 
int BaseMpgVehicleId [get, set]
 The base vehicle for energy consumption More...
 
bool CalulatedCorrectly [get]
 True if the calculations for that vehicle where correclty done More...
 
int Id [get, set]
 Unique ID for this vehicle among the vehicles More...
 
string Name [get, set]
 Name for this vehicle as it is going to show on the graphical interface More...
 
Dictionary< string, IVehicleModeOperatingModes [get]
 Returns a IEnumberable of the different vehicle operating modes usually modes types are "cd" or "cs" More...
 
string PictureName [get, set]
 Image Name that represents the Vehicle More...
 

Detailed Description

Stores the data associated with a vehicle, its properties and its modes

Constructor & Destructor Documentation

Greet.DataStructureV3.Entities.Vehicle.Vehicle ( )

Default vehicle constructor

Member Function Documentation

void Greet.DataStructureV3.Entities.Vehicle.InitializeMinYearDefinition ( )

This method loops thought the modes and find the minimum year for which all the modes (emissions and energies consumptions) are defined The value is stored in the minYearDefinition attribute of a vehicle

Member Data Documentation

Boolean Greet.DataStructureV3.Entities.Vehicle._gridConnected

Flag set to true if the vehicle is grid connected (we should try to avoid that and handle this situation from the Modes directly)

string Greet.DataStructureV3.Entities.Vehicle._pictureName = Constants.EmptyPicture

Picture name that can be used to represent the vehicle

Property Documentation

int Greet.DataStructureV3.Entities.Vehicle.BaseEmissionVehicleId
getset

The base vehicle for emissions

int Greet.DataStructureV3.Entities.Vehicle.BaseMpgVehicleId
getset

The base vehicle for energy consumption


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