Eclipse SUMO - Simulation of Urban MObility
PollutantsInterface::Helper Class Referenceabstract

abstract superclass for the model helpers More...

#include <PollutantsInterface.h>

Inheritance diagram for PollutantsInterface::Helper:
Collaboration diagram for PollutantsInterface::Helper:

Public Member Functions

void addAllClassesInto (std::vector< SUMOEmissionClass > &list) const
 Add all known emission classes of this model to the given container. More...
 
virtual double compute (const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const std::map< int, double > *param) const =0
 Returns the amount of the emitted pollutant given the vehicle type and state (in mg/s or ml/s for fuel) More...
 
virtual SUMOEmissionClass getClassByName (const std::string &eClass, const SUMOVehicleClass vc)
 Returns the emission class associated with the given name, aliases are possible If this method is asked for the "unknown" class it should return the default (possibly depending on the given vehicle class). The class name is case insensitive. More...
 
const std::string getClassName (const SUMOEmissionClass c) const
 Returns the complete name of the emission class including the model. More...
 
virtual double getModifiedAccel (const SUMOEmissionClass c, const double v, const double a, const double slope) const
 Returns the adapted acceleration value, useful for comparing with external PHEMlight references. Default implementation returns always the input accel. More...
 
const std::string & getName () const
 Returns the name of the model. More...
 
 Helper (std::string name)
 Constructor, intializes the name. More...
 
virtual bool isSilent (const SUMOEmissionClass c)
 Returns whether the class denotes a silent vehicle for interfacing with the noise model. By default the first class in each model is the silent class. More...
 

Protected Attributes

StringBijection< SUMOEmissionClassmyEmissionClassStrings
 Mapping between emission class names and integer representations. More...
 
const std::string myName
 the name of the model More...
 

Private Member Functions

Helperoperator= (const Helper &)=delete
 invalidate copy constructor More...
 

Methods for Amitran interfaces

virtual SUMOEmissionClass getClass (const SUMOEmissionClass base, const std::string &vClass, const std::string &fuel, const std::string &eClass, const double weight) const
 Returns the emission class described by the given parameters. The base is used to determine the model to use and as default return values. Default implementation returns always base. More...
 
virtual std::string getAmitranVehicleClass (const SUMOEmissionClass c) const
 Returns the vehicle class described by this emission class as described in the Amitran interface (Passenger, ...) Default implementation returns always "Passenger". More...
 
virtual std::string getFuel (const SUMOEmissionClass c) const
 Returns the fuel type described by this emission class as described in the Amitran interface (Gasoline, Diesel, ...) Default implementation returns always "Gasoline". More...
 
virtual int getEuroClass (const SUMOEmissionClass c) const
 Returns the Euro emission class described by this emission class as described in the Amitran interface (0, ..., 6) Default implementation returns always 0. More...
 
virtual double getWeight (const SUMOEmissionClass c) const
 Returns a reference weight in kg described by this emission class as described in the Amitran interface It might return -1, if the weight is not important to distinguish different emission classes. Default implementation returns always -1. More...
 

Detailed Description

abstract superclass for the model helpers

Definition at line 102 of file PollutantsInterface.h.

Constructor & Destructor Documentation

◆ Helper()

PollutantsInterface::Helper::Helper ( std::string  name)
inline

Constructor, intializes the name.

Parameters
[in]namethe name of the model (string before the '/' in the emission class attribute)

Definition at line 107 of file PollutantsInterface.h.

Member Function Documentation

◆ addAllClassesInto()

void PollutantsInterface::Helper::addAllClassesInto ( std::vector< SUMOEmissionClass > &  list) const
inline

Add all known emission classes of this model to the given container.

Parameters
[in]listthe vector to add to

Definition at line 244 of file PollutantsInterface.h.

References StringBijection< T >::addKeysInto(), and myEmissionClassStrings.

Referenced by PollutantsInterface::getAllClasses(), and PollutantsInterface::getAllClassesStr().

◆ compute()

virtual double PollutantsInterface::Helper::compute ( const SUMOEmissionClass  c,
const EmissionType  e,
const double  v,
const double  a,
const double  slope,
const std::map< int, double > *  param 
) const
pure virtual

Returns the amount of the emitted pollutant given the vehicle type and state (in mg/s or ml/s for fuel)

Parameters
[in]cThe vehicle emission class
[in]ethe type of emission (CO, CO2, ...)
[in]vThe vehicle's current velocity
[in]aThe vehicle's current acceleration
[in]slopeThe road's slope at vehicle's position [deg]
Returns
The amount emitted by the given emission class when moving with the given velocity and acceleration [mg/s or ml/s]

Implemented in HelpersPHEMlight, HelpersHBEFA3, HelpersHBEFA, and HelpersEnergy.

Referenced by PollutantsInterface::compute(), PollutantsInterface::computeAll(), and PollutantsInterface::computeDefault().

◆ getAmitranVehicleClass()

virtual std::string PollutantsInterface::Helper::getAmitranVehicleClass ( const SUMOEmissionClass  c) const
inlinevirtual

Returns the vehicle class described by this emission class as described in the Amitran interface (Passenger, ...) Default implementation returns always "Passenger".

Parameters
[in]cthe emission class
Returns
the name of the vehicle class

Reimplemented in HelpersPHEMlight, and HelpersHBEFA3.

Definition at line 179 of file PollutantsInterface.h.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getAmitranVehicleClass().

◆ getClass()

virtual SUMOEmissionClass PollutantsInterface::Helper::getClass ( const SUMOEmissionClass  base,
const std::string &  vClass,
const std::string &  fuel,
const std::string &  eClass,
const double  weight 
) const
inlinevirtual

Returns the emission class described by the given parameters. The base is used to determine the model to use and as default return values. Default implementation returns always base.

Parameters
[in]basethe base class giving the model and the default
[in]vClassthe vehicle class as described in the Amitran interface (Passenger, ...)
[in]fuelthe fuel type as described in the Amitran interface (Gasoline, Diesel, ...)
[in]eClassthe emission class as described in the Amitran interface (Euro0, ...)
[in]weightthe vehicle weight in kg as described in the Amitran interface
Returns
the class described by the parameters

Reimplemented in HelpersPHEMlight, and HelpersHBEFA3.

Definition at line 165 of file PollutantsInterface.h.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getClass().

◆ getClassByName()

virtual SUMOEmissionClass PollutantsInterface::Helper::getClassByName ( const std::string &  eClass,
const SUMOVehicleClass  vc 
)
inlinevirtual

Returns the emission class associated with the given name, aliases are possible If this method is asked for the "unknown" class it should return the default (possibly depending on the given vehicle class). The class name is case insensitive.

Parameters
[in]eClassthe name of the emission class (string after the '/' in the emission class attribute)
[in]vcthe vehicle class to use when determining default class
Returns
the name of the model (string before the '/' in the emission class)

Reimplemented in HelpersPHEMlight.

Definition at line 125 of file PollutantsInterface.h.

References StringBijection< T >::get(), StringBijection< T >::hasString(), myEmissionClassStrings, and UNUSED_PARAMETER.

Referenced by PollutantsInterface::getClassByName().

◆ getClassName()

const std::string PollutantsInterface::Helper::getClassName ( const SUMOEmissionClass  c) const
inline

Returns the complete name of the emission class including the model.

Parameters
[in]cthe emission class
Returns
the name of the class (the complete emission class attribute)

Definition at line 139 of file PollutantsInterface.h.

References StringBijection< T >::getString(), myEmissionClassStrings, and myName.

Referenced by PollutantsInterface::getName().

◆ getEuroClass()

virtual int PollutantsInterface::Helper::getEuroClass ( const SUMOEmissionClass  c) const
inlinevirtual

Returns the Euro emission class described by this emission class as described in the Amitran interface (0, ..., 6) Default implementation returns always 0.

Parameters
[in]cthe emission class
Returns
the Euro class

Reimplemented in HelpersPHEMlight, and HelpersHBEFA3.

Definition at line 199 of file PollutantsInterface.h.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getEuroClass().

◆ getFuel()

virtual std::string PollutantsInterface::Helper::getFuel ( const SUMOEmissionClass  c) const
inlinevirtual

Returns the fuel type described by this emission class as described in the Amitran interface (Gasoline, Diesel, ...) Default implementation returns always "Gasoline".

Parameters
[in]cthe emission class
Returns
the fuel type

Reimplemented in HelpersPHEMlight, and HelpersHBEFA3.

Definition at line 189 of file PollutantsInterface.h.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getFuel().

◆ getModifiedAccel()

virtual double PollutantsInterface::Helper::getModifiedAccel ( const SUMOEmissionClass  c,
const double  v,
const double  a,
const double  slope 
) const
inlinevirtual

Returns the adapted acceleration value, useful for comparing with external PHEMlight references. Default implementation returns always the input accel.

Parameters
[in]cthe emission class
[in]vthe speed value
[in]athe acceleration value
[in]slopeThe road's slope at vehicle's position [deg]
Returns
the modified acceleration

Reimplemented in HelpersPHEMlight.

Definition at line 234 of file PollutantsInterface.h.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getModifiedAccel().

◆ getName()

const std::string& PollutantsInterface::Helper::getName ( ) const
inline

Returns the name of the model.

Returns
the name of the model (string before the '/' in the emission class attribute)

Definition at line 112 of file PollutantsInterface.h.

References myName.

◆ getWeight()

virtual double PollutantsInterface::Helper::getWeight ( const SUMOEmissionClass  c) const
inlinevirtual

Returns a reference weight in kg described by this emission class as described in the Amitran interface It might return -1, if the weight is not important to distinguish different emission classes. Default implementation returns always -1.

Parameters
[in]cthe emission class
Returns
a reference weight

Reimplemented in HelpersPHEMlight.

Definition at line 210 of file PollutantsInterface.h.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getWeight().

◆ isSilent()

virtual bool PollutantsInterface::Helper::isSilent ( const SUMOEmissionClass  c)
inlinevirtual

Returns whether the class denotes a silent vehicle for interfacing with the noise model. By default the first class in each model is the silent class.

Parameters
[in]cthe emission class
Returns
whether the class denotes a silent vehicle

Definition at line 148 of file PollutantsInterface.h.

References PollutantsInterface::HEAVY_BIT.

Referenced by PollutantsInterface::isSilent().

◆ operator=()

Helper& PollutantsInterface::Helper::operator= ( const Helper )
privatedelete

invalidate copy constructor

Field Documentation

◆ myEmissionClassStrings

◆ myName

const std::string PollutantsInterface::Helper::myName
protected

the name of the model

Definition at line 250 of file PollutantsInterface.h.

Referenced by getClassName(), and getName().


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