Helper methods for PHEMlight-based emission computation. More...

#include <HelpersPHEMlight.h>

Inheritance diagram for HelpersPHEMlight:

Collaboration diagram for HelpersPHEMlight:

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 PollutantsInterface::EmissionType e, const double v, const double a, const double slope, const EnergyParams *param) const
	Returns the amount of emitted pollutant given the vehicle type and state (in mg/s or in ml/s for fuel)

std::string	getAmitranVehicleClass (const SUMOEmissionClass c) const
	Returns the vehicle class described by this emission class as described in the Amitran interface (Passenger, ...)

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.

virtual SUMOEmissionClass	getClassByName (const std::string &eClass, const SUMOVehicleClass vc)
	Checks whether the string describes a known vehicle class.

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.

int	getEuroClass (const SUMOEmissionClass c) const
	Returns the Euro emission class described by this emission class as described in the Amitran interface (0, ..., 6)

std::string	getFuel (const SUMOEmissionClass c) const
	Returns the fuel type described by this emission class as described in the Amitran interface (Gasoline, Diesel, ...)

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.

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

double	getWeight (const SUMOEmissionClass c) const
	Returns a reference weight in kg described by this emission class as described in the Amitran interface This implementation returns only meaningful values for Solo_LKW (truck without trailer) and LNF (light duty vehicles).

	HelpersPHEMlight ()
	Constructor.

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	~HelpersPHEMlight ()
	Destructor.

Protected Member Functions
	HelpersPHEMlight (std::string name, const int baseIndex, const int defaultClass)
	Constructor for subclasses.

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
double	getEmission (const PHEMCEP oldCep, PHEMlightdll::CEP currCep, const std::string &e, const double p, const double v) const
	Returns the amount of emitted pollutant given the vehicle type and state (in mg/s or in ml/s for fuel)

Private Attributes
PHEMlightdll::CEPHandler	myCEPHandler

std::map< SUMOEmissionClass, PHEMlightdll::CEP * >	myCEPs

PHEMlightdll::Helpers	myHelper

int	myIndex
	the index of the next class

Static Private Attributes
static const int	PHEMLIGHT_BASE = 3 << 16

Detailed Description

Helper methods for PHEMlight-based emission computation.

Definition at line 46 of file HelpersPHEMlight.h.

Constructor & Destructor Documentation

◆ HelpersPHEMlight() [1/2]

HelpersPHEMlight::HelpersPHEMlight ( )

Constructor.

Definition at line 43 of file HelpersPHEMlight.cpp.

◆ ~HelpersPHEMlight()

HelpersPHEMlight::~HelpersPHEMlight ( )

virtual

Destructor.

Definition at line 49 of file HelpersPHEMlight.cpp.

References myCEPs.

◆ HelpersPHEMlight() [2/2]

HelpersPHEMlight::HelpersPHEMlight	(	std::string	name,
		const int	baseIndex,
		const int	defaultClass
	)

inlineprotected

Constructor for subclasses.

Parameters

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

Definition at line 63 of file HelpersPHEMlight.h.

Member Function Documentation

◆ addAllClassesInto()

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

inherited

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

Parameters

[in] list the vector to add to

Definition at line 214 of file PollutantsInterface.cpp.

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

Here is the caller graph for this function:

◆ compute()

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

virtual

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

Parameters

[in]	c	The vehicle emission class
[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]

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

Reimplemented from PollutantsInterface::Helper.

Reimplemented in HelpersPHEMlight5.

Definition at line 273 of file HelpersPHEMlight.cpp.

◆ getAmitranVehicleClass()

std::string HelpersPHEMlight::getAmitranVehicleClass ( const SUMOEmissionClass c ) const

virtual

Returns the vehicle class described by this emission class as described in the Amitran interface (Passenger, ...)

Parameters

[in] c the emission class

Returns: the name of the vehicle class

Reimplemented from PollutantsInterface::Helper.

Definition at line 169 of file HelpersPHEMlight.cpp.

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

◆ getClass()

SUMOEmissionClass HelpersPHEMlight::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.

Parameters

[in]	base	the base class giving 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 from PollutantsInterface::Helper.

Definition at line 106 of file HelpersPHEMlight.cpp.

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

◆ getClassByName()

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

virtual

Checks whether the string describes a known vehicle class.

Parameters

[in] eClass The string describing the vehicle emission class

Returns: whether it describes a valid emission class

Reimplemented from PollutantsInterface::Helper.

Reimplemented in HelpersPHEMlight5.

Definition at line 57 of file HelpersPHEMlight.cpp.

References StringBijection< T >::addAlias(), StringBijection< T >::get(), OptionsCont::getBool(), PHEMlightdll::CEPHandler::GetCEP(), PHEMlightdll::CEPHandler::getCEPS(), getClassByName(), PHEMlightdll::Helpers::getErrMsg(), PHEMlightdll::Helpers::getgClass(), PHEMCEPHandler::getHandlerInstance(), OptionsCont::getOptions(), StringBijection< T >::hasString(), PollutantsInterface::HEAVY_BIT, StringBijection< T >::insert(), myCEPHandler, myCEPs, PollutantsInterface::Helper::myEmissionClassStrings, myHelper, myIndex, PollutantsInterface::Helper::myVolumetricFuel, StringBijection< T >::remove(), PHEMlightdll::Helpers::setclass(), PHEMlightdll::Helpers::setCommentPrefix(), PHEMlightdll::Helpers::setPHEMDataV(), and StringUtils::to_lower_case().

Referenced by getClassByName().

Here is the caller graph for this function:

◆ getClassName()

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

inherited

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 125 of file PollutantsInterface.cpp.

Referenced by PollutantsInterface::getName().

Here is the caller graph for this function:

◆ getCoastingDecel()

double HelpersPHEMlight::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.

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 from PollutantsInterface::Helper.

Reimplemented in HelpersPHEMlight5.

Definition at line 267 of file HelpersPHEMlight.cpp.

References myCEPs.

◆ getEmission()

double HelpersPHEMlight::getEmission	(	const PHEMCEP *	oldCep,
		PHEMlightdll::CEP *	currCep,
		const std::string &	e,
		const double	p,
		const double	v
	)		const

private

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

Parameters

[in]	currCep	The vehicle emission class
[in]	e	The emission type
[in]	p	The vehicle's current power
[in]	v	The vehicle's current velocity

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

Definition at line 248 of file HelpersPHEMlight.cpp.

References PHEMlightdll::CEP::GetEmission(), PHEMCEP::GetEmission(), and myHelper.

Referenced by compute().

Here is the caller graph for this function:

◆ getEuroClass()

int HelpersPHEMlight::getEuroClass ( const SUMOEmissionClass c ) const

virtual

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

Parameters

[in] c the emission class

Returns: the Euro class

Reimplemented from PollutantsInterface::Helper.

Definition at line 205 of file HelpersPHEMlight.cpp.

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

◆ getFuel()

std::string HelpersPHEMlight::getFuel ( const SUMOEmissionClass c ) const

virtual

Returns the fuel type described by this emission class as described in the Amitran interface (Gasoline, Diesel, ...)

Parameters

[in] c the emission class

Returns: the fuel type

Reimplemented from PollutantsInterface::Helper.

Reimplemented in HelpersPHEMlight5.

Definition at line 191 of file HelpersPHEMlight.cpp.

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

◆ getModifiedAccel()

double HelpersPHEMlight::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.

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 from PollutantsInterface::Helper.

Reimplemented in HelpersPHEMlight5.

Definition at line 257 of file HelpersPHEMlight.cpp.

References PHEMlightdll::CEP::GetMaxAccel(), MIN2(), and myCEPs.

Referenced by compute().

Here is the caller graph for this function:

◆ getName()

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

inherited

Returns the name of the model.

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

Definition at line 108 of file PollutantsInterface.cpp.

◆ getWeight()

double HelpersPHEMlight::getWeight ( const SUMOEmissionClass c ) const

virtual

Returns a reference weight in kg described by this emission class as described in the Amitran interface This implementation returns only meaningful values for Solo_LKW (truck without trailer) and LNF (light duty vehicles).

Parameters

[in] c the emission class

Returns: a reference weight

Reimplemented from PollutantsInterface::Helper.

Reimplemented in HelpersPHEMlight5.

Definition at line 225 of file HelpersPHEMlight.cpp.

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

◆ includesClass()

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

inherited

Definition at line 220 of file PollutantsInterface.cpp.

◆ isSilent()

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

virtualinherited

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 131 of file PollutantsInterface.cpp.

References PollutantsInterface::HEAVY_BIT.

Referenced by PollutantsInterface::isSilent().

Here is the caller graph for this function:

Field Documentation

◆ myBaseIndex

const int PollutantsInterface::Helper::myBaseIndex

protectedinherited

the starting index for classes of this model

Definition at line 228 of file PollutantsInterface.h.

◆ myCEPHandler

PHEMlightdll::CEPHandler HelpersPHEMlight::myCEPHandler

private

Definition at line 148 of file HelpersPHEMlight.h.

Referenced by getClassByName().

◆ myCEPs

std::map<SUMOEmissionClass, PHEMlightdll::CEP*> HelpersPHEMlight::myCEPs

private

Definition at line 150 of file HelpersPHEMlight.h.

Referenced by compute(), getClassByName(), getCoastingDecel(), getModifiedAccel(), and ~HelpersPHEMlight().

◆ myEmissionClassStrings

StringBijection<SUMOEmissionClass> PollutantsInterface::Helper::myEmissionClassStrings

protectedinherited

Mapping between emission class names and integer representations.

Definition at line 234 of file PollutantsInterface.h.

Referenced by HelpersHBEFA3::getAmitranVehicleClass(), HelpersHBEFA4::getAmitranVehicleClass(), getAmitranVehicleClass(), HelpersHBEFA3::getClass(), HelpersHBEFA4::getClass(), getClass(), getClassByName(), HelpersPHEMlight5::getClassByName(), HelpersHBEFA3::getEuroClass(), HelpersHBEFA4::getEuroClass(), getEuroClass(), HelpersHBEFA3::getFuel(), HelpersHBEFA4::getFuel(), getFuel(), HelpersPHEMlight5::getFuel(), getWeight(), PollutantsInterface::Helper::Helper(), HelpersHBEFA::HelpersHBEFA(), HelpersHBEFA3::HelpersHBEFA3(), and HelpersHBEFA4::HelpersHBEFA4().

◆ myHelper

PHEMlightdll::Helpers HelpersPHEMlight::myHelper

mutableprivate

Definition at line 149 of file HelpersPHEMlight.h.

Referenced by compute(), getClassByName(), and getEmission().

◆ myIndex

int HelpersPHEMlight::myIndex

private

the index of the next class

Definition at line 147 of file HelpersPHEMlight.h.

Referenced by getClassByName().

◆ myName

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

protectedinherited

the name of the model

Definition at line 225 of file PollutantsInterface.h.

◆ myVolumetricFuel

bool PollutantsInterface::Helper::myVolumetricFuel

protectedinherited

return fuel consumption in l instead of mg

Definition at line 231 of file PollutantsInterface.h.

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

◆ PHEMLIGHT_BASE

const int HelpersPHEMlight::PHEMLIGHT_BASE = 3 << 16

staticprivate

Definition at line 48 of file HelpersPHEMlight.h.

◆ ZERO_SPEED_ACCURACY

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

staticprotectedinherited

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 Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HelpersPHEMlight() [1/2]

◆ ~HelpersPHEMlight()

◆ HelpersPHEMlight() [2/2]

Member Function Documentation

◆ addAllClassesInto()

◆ compute()

◆ getAmitranVehicleClass()

◆ getClass()

◆ getClassByName()

◆ getClassName()

◆ getCoastingDecel()

◆ getEmission()

◆ getEuroClass()

◆ getFuel()

◆ getModifiedAccel()

◆ getName()

◆ getWeight()

◆ includesClass()

◆ isSilent()

Field Documentation

◆ myBaseIndex

◆ myCEPHandler

◆ myCEPs

◆ myEmissionClassStrings

◆ myHelper

◆ myIndex

◆ myName

◆ myVolumetricFuel

◆ PHEMLIGHT_BASE

◆ ZERO_SPEED_ACCURACY