zero emission model, used as superclass for the other 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.

virtual double	compute (const SUMOEmissionClass c, const EmissionType e, const double v, const double a, const double slope, const EnergyParams *param) const
	Returns the amount of the emitted pollutant given the vehicle type and state (in mg/s or ml/s for fuel)

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.

const std::string	getClassName (const SUMOEmissionClass c) const
	Returns the complete name of the emission class including the model.

virtual double	getCoastingDecel (const SUMOEmissionClass c, const double v, const double a, const double slope, const EnergyParams *param) const
	Returns the maximum deceleration value (as a negative number), which can still be considered as non-braking. Default implementation returns always zero.

virtual double	getModifiedAccel (const SUMOEmissionClass c, const double v, const double a, const double slope, const EnergyParams *param) const
	Returns the adapted acceleration value, useful for comparing with external PHEMlight references. Default implementation returns always the input accel.

const std::string &	getName () const
	Returns the name of the model.

	Helper (std::string name, const int baseIndex, const int defaultClass)
	Constructor, intializes the name.

bool	includesClass (const SUMOEmissionClass c) const

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.

virtual	~Helper ()
	empty destructor

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.

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".

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".

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.

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.

Protected Attributes
const int	myBaseIndex
	the starting index for classes of this model

StringBijection< SUMOEmissionClass >	myEmissionClassStrings
	Mapping between emission class names and integer representations.

const std::string	myName
	the name of the model

bool	myVolumetricFuel
	return fuel consumption in l instead of mg

Static Protected Attributes
static const double	ZERO_SPEED_ACCURACY = .5
	the lowest speed which allows reliable coasting calculations

Private Member Functions
Helper &	operator= (const Helper &)=delete
	invalidate copy constructor

Detailed Description

zero emission model, used as superclass for the other model helpers

Definition at line 96 of file PollutantsInterface.h.

Constructor & Destructor Documentation

◆ Helper()

PollutantsInterface::Helper::Helper	(	std::string	name,
		const int	baseIndex,
		const int	defaultClass
	)

Constructor, intializes the name.

Parameters

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

Definition at line 96 of file PollutantsInterface.cpp.

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

◆ ~Helper()

virtual PollutantsInterface::Helper::~Helper ( )

inlinevirtual

empty destructor

Definition at line 104 of file PollutantsInterface.h.

Member Function Documentation

◆ addAllClassesInto()

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

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

Parameters

[in] list the vector to add to

Definition at line 213 of file PollutantsInterface.cpp.

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

Here is the caller graph for this function:

◆ compute()

double PollutantsInterface::Helper::compute	(	const SUMOEmissionClass	c,
		const EmissionType	e,
		const double	v,
		const double	a,
		const double	slope,
		const EnergyParams *	param
	)		const

virtual

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

Parameters

[in]	c	The vehicle emission class
[in]	e	the type of emission (CO, CO2, ...)
[in]	v	The vehicle's current velocity
[in]	a	The vehicle's current acceleration
[in]	slope	The road's slope at vehicle's position [deg]
[in]	param	parameter of the emission model affecting the computation

Returns: The amount emitted by the given emission class when moving with the given velocity and acceleration [mg/s or ml/s]

Reimplemented in HelpersEnergy, HelpersHBEFA, HelpersHBEFA3, HelpersHBEFA4, HelpersPHEMlight, HelpersPHEMlight5, and HelpersMMPEVEM.

Definition at line 174 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

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

Here is the caller graph for this function:

◆ getAmitranVehicleClass()

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

virtual

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

Parameters

[in] c the emission class

Returns: the name of the vehicle class

Reimplemented in HelpersHBEFA3, HelpersHBEFA4, and HelpersPHEMlight.

Definition at line 146 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getAmitranVehicleClass().

Here is the caller graph for this function:

◆ getClass()

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

virtual

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]	base	the base class giving the model and the default
[in]	vClass	the vehicle class as described in the Amitran interface (Passenger, ...)
[in]	fuel	the fuel type as described in the Amitran interface (Gasoline, Diesel, ...)
[in]	eClass	the emission class as described in the Amitran interface (Euro0, ...)
[in]	weight	the vehicle weight in kg as described in the Amitran interface

Returns: the class described by the parameters

Reimplemented in HelpersHBEFA3, HelpersHBEFA4, and HelpersPHEMlight.

Definition at line 136 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getClass().

Here is the caller graph for this function:

◆ getClassByName()

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

virtual

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]	eClass	the name of the emission class (string after the '/' in the emission class attribute)
[in]	vc	the vehicle class to use when determining default class

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

Reimplemented in HelpersPHEMlight, and HelpersPHEMlight5.

Definition at line 113 of file PollutantsInterface.cpp.

References OptionsCont::exists(), OptionsCont::getBool(), OptionsCont::getOptions(), StringUtils::to_lower_case(), and UNUSED_PARAMETER.

Referenced by PollutantsInterface::getClassByName().

Here is the caller graph for this function:

◆ getClassName()

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

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

Parameters

[in] c the emission class

Returns: the name of the class (the complete emission class attribute)

Definition at line 124 of file PollutantsInterface.cpp.

Referenced by PollutantsInterface::getName().

Here is the caller graph for this function:

◆ getCoastingDecel()

double PollutantsInterface::Helper::getCoastingDecel	(	const SUMOEmissionClass	c,
		const double	v,
		const double	a,
		const double	slope,
		const EnergyParams *	param
	)		const

virtual

Returns the maximum deceleration value (as a negative number), which can still be considered as non-braking. Default implementation returns always zero.

Parameters

[in]	c	the emission class
[in]	v	the speed value
[in]	a	the acceleration value
[in]	slope	The road's slope at vehicle's position [deg]
[in]	param	parameter of the emission model affecting the computation

Returns: the coasting deceleration

Reimplemented in HelpersPHEMlight, and HelpersPHEMlight5.

Definition at line 196 of file PollutantsInterface.cpp.

References PollutantsInterface::getCoastingDecel(), EnergyParams::getDefault(), EnergyParams::getDouble(), PHEMlightdllV5::Constants::GRAVITY_CONST, MIN2(), PHEMlightdllV5::Constants::SPEED_DCEL_MIN, SUMO_ATTR_FRONTSURFACEAREA, and SUMO_ATTR_MASS.

Referenced by HelpersHBEFA::compute(), HelpersHBEFA3::compute(), HelpersHBEFA4::compute(), and PollutantsInterface::getCoastingDecel().

Here is the caller graph for this function:

◆ getEuroClass()

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

virtual

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] c the emission class

Returns: the Euro class

Reimplemented in HelpersHBEFA3, HelpersHBEFA4, and HelpersPHEMlight.

Definition at line 160 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getEuroClass().

Here is the caller graph for this function:

◆ getFuel()

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

virtual

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

Parameters

[in] c the emission class

Returns: the fuel type

Reimplemented in HelpersHBEFA3, HelpersHBEFA4, HelpersPHEMlight, HelpersPHEMlight5, HelpersEnergy, and HelpersMMPEVEM.

Definition at line 153 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getFuel().

Here is the caller graph for this function:

◆ getModifiedAccel()

double PollutantsInterface::Helper::getModifiedAccel	(	const SUMOEmissionClass	c,
		const double	v,
		const double	a,
		const double	slope,
		const EnergyParams *	param
	)		const

virtual

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

Parameters

[in]	c	the emission class
[in]	v	the speed value
[in]	a	the acceleration value
[in]	slope	The road's slope at vehicle's position [deg]

Returns: the modified acceleration

Reimplemented in HelpersPHEMlight, and HelpersPHEMlight5.

Definition at line 186 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getModifiedAccel().

Here is the caller graph for this function:

◆ getName()

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

Returns the name of the model.

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

Definition at line 107 of file PollutantsInterface.cpp.

◆ getWeight()

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

virtual

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] c the emission class

Returns: a reference weight

Reimplemented in HelpersPHEMlight, HelpersPHEMlight5, HelpersEnergy, and HelpersMMPEVEM.

Definition at line 167 of file PollutantsInterface.cpp.

References UNUSED_PARAMETER.

Referenced by PollutantsInterface::getWeight().

Here is the caller graph for this function:

◆ includesClass()

bool PollutantsInterface::Helper::includesClass ( const SUMOEmissionClass c ) const

Definition at line 219 of file PollutantsInterface.cpp.

◆ isSilent()

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

virtual

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] c the emission class

Returns: whether the class denotes a silent vehicle

Definition at line 130 of file PollutantsInterface.cpp.

References PollutantsInterface::HEAVY_BIT.

Referenced by PollutantsInterface::isSilent().

Here is the caller graph for this function:

◆ operator=()

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

privatedelete

invalidate copy constructor

Field Documentation

◆ myBaseIndex

const int PollutantsInterface::Helper::myBaseIndex

protected

the starting index for classes of this model

Definition at line 228 of file PollutantsInterface.h.

◆ myEmissionClassStrings

StringBijection<SUMOEmissionClass> PollutantsInterface::Helper::myEmissionClassStrings

protected

Mapping between emission class names and integer representations.

Definition at line 234 of file PollutantsInterface.h.

◆ myName

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

protected

the name of the model

Definition at line 225 of file PollutantsInterface.h.

◆ myVolumetricFuel

bool PollutantsInterface::Helper::myVolumetricFuel

protected

return fuel consumption in l instead of mg

Definition at line 231 of file PollutantsInterface.h.

Referenced by HelpersHBEFA::compute(), HelpersHBEFA3::compute(), HelpersHBEFA4::compute(), HelpersPHEMlight::compute(), HelpersPHEMlight5::compute(), HelpersPHEMlight::getClassByName(), and HelpersPHEMlight5::getClassByName().

◆ ZERO_SPEED_ACCURACY

const double PollutantsInterface::Helper::ZERO_SPEED_ACCURACY = .5

staticprotected

the lowest speed which allows reliable coasting calculations

Definition at line 222 of file PollutantsInterface.h.

Referenced by HelpersHBEFA::compute(), HelpersHBEFA3::compute(), and HelpersHBEFA4::compute().

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

Public Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Helper()

◆ ~Helper()

Member Function Documentation

◆ addAllClassesInto()

◆ compute()

◆ getAmitranVehicleClass()

◆ getClass()

◆ getClassByName()

◆ getClassName()

◆ getCoastingDecel()

◆ getEuroClass()

◆ getFuel()

◆ getModifiedAccel()

◆ getName()

◆ getWeight()

◆ includesClass()

◆ isSilent()

◆ operator=()

Field Documentation

◆ myBaseIndex

◆ myEmissionClassStrings

◆ myName

◆ myVolumetricFuel

◆ ZERO_SPEED_ACCURACY