SUMO - Simulation of Urban MObility
MSSOTLPlatoonPolicy Class Reference

Class for low-level platoon policy. More...

#include <MSSOTLPlatoonPolicy.h>

Inheritance diagram for MSSOTLPlatoonPolicy:
Inheritance graph
Collaboration diagram for MSSOTLPlatoonPolicy:
Collaboration graph

Public Member Functions

void addParameter (const std::string &key, const std::string &value)
 Adds a parameter. More...
 
void addParameter (const std::map< std::string, std::string > &mapArg)
 Adds all given parameter. More...
 
void addParameter (const Parameterised &p)
 Adds all given parameter. More...
 
bool canRelease (SUMOTime elapsed, bool thresholdPassed, bool pushButtonPressed, const MSPhaseDefinition *stage, int vehicleCount)
 
void clearParameter ()
 Clears the parameter map. More...
 
SUMOReal computeDesirability (SUMOReal vehInMeasure, SUMOReal vehOutMeasure, SUMOReal vehInDispersionMeasure, SUMOReal vehOutDispersionMeasure)
 Computes the desirability of this policy, necessary when used in combination with an high level policy. More...
 
SUMOReal computeDesirability (SUMOReal vehInMeasure, SUMOReal vehOutMeasure)
 
virtual int decideNextPhase (SUMOTime elapsed, const MSPhaseDefinition *stage, int currentPhaseIndex, int phaseMaxCTS, bool thresholdPassed, bool pushButtonPressed, int vehicleCount)
 
MSSOTLPolicyDesirabilitygetDesirabilityAlgorithm ()
 
const std::map< std::string, std::string > & getMap () const
 Returns the inner key/value map. More...
 
std::string getName ()
 
const std::string & getParameter (const std::string &key, const std::string &defaultValue) const
 Returns the value for a given key. More...
 
virtual SUMOReal getThetaSensitivity ()
 
bool knowsParameter (const std::string &key) const
 Returns whether the parameter is known. More...
 
 MSSOTLPlatoonPolicy (const std::map< std::string, std::string > &parameters)
 
 MSSOTLPlatoonPolicy (MSSOTLPolicyDesirability *desirabilityAlgorithm)
 
 MSSOTLPlatoonPolicy (MSSOTLPolicyDesirability *desirabilityAlgorithm, const std::map< std::string, std::string > &parameters)
 
virtual void setThetaSensitivity (SUMOReal val)
 

Protected Member Functions

void init (std::string prefix, const Parameterised *parameterised)
 
void init ()
 
void init (std::string prefix, const Parameterised *parameterised)
 
bool pushButtonLogic (SUMOTime elapsed, bool pushButtonPressed, const MSPhaseDefinition *stage)
 
bool sigmoidLogic (SUMOTime elapsed, const MSPhaseDefinition *stage, int vehicleCount)
 

Protected Attributes

SUMOReal m_k
 
std::string m_prefix
 
std::string m_prefix
 
SUMOReal m_pushButtonScaleFactor
 
bool m_useSigmoid
 

Detailed Description

Class for low-level platoon policy.

Definition at line 43 of file MSSOTLPlatoonPolicy.h.

Constructor & Destructor Documentation

§ MSSOTLPlatoonPolicy() [1/3]

MSSOTLPlatoonPolicy::MSSOTLPlatoonPolicy ( const std::map< std::string, std::string > &  parameters)

Definition at line 25 of file MSSOTLPlatoonPolicy.cpp.

References init().

§ MSSOTLPlatoonPolicy() [2/3]

MSSOTLPlatoonPolicy::MSSOTLPlatoonPolicy ( MSSOTLPolicyDesirability desirabilityAlgorithm)

§ MSSOTLPlatoonPolicy() [3/3]

MSSOTLPlatoonPolicy::MSSOTLPlatoonPolicy ( MSSOTLPolicyDesirability desirabilityAlgorithm,
const std::map< std::string, std::string > &  parameters 
)

Member Function Documentation

§ addParameter() [1/3]

§ addParameter() [2/3]

void Parameterised::addParameter ( const std::map< std::string, std::string > &  mapArg)
inherited

Adds all given parameter.

Parameters
[in]mapArgThe keys/values to insert

Definition at line 59 of file Parameterised.cpp.

References Parameterised::myMap.

§ addParameter() [3/3]

void Parameterised::addParameter ( const Parameterised p)
inherited

Adds all given parameter.

Parameters
[in]pThe keys/values to insert

Definition at line 67 of file Parameterised.cpp.

References Parameterised::myMap.

§ canRelease()

bool MSSOTLPlatoonPolicy::canRelease ( SUMOTime  elapsed,
bool  thresholdPassed,
bool  pushButtonPressed,
const MSPhaseDefinition stage,
int  vehicleCount 
)
virtual

§ clearParameter()

void Parameterised::clearParameter ( )
inherited

Clears the parameter map.

Definition at line 91 of file Parameterised.cpp.

References Parameterised::myMap.

§ computeDesirability() [1/2]

SUMOReal MSSOTLPolicy::computeDesirability ( SUMOReal  vehInMeasure,
SUMOReal  vehOutMeasure,
SUMOReal  vehInDispersionMeasure,
SUMOReal  vehOutDispersionMeasure 
)
inherited

Computes the desirability of this policy, necessary when used in combination with an high level policy.

Definition at line 106 of file MSSOTLPolicy.cpp.

References MSSOTLPolicyDesirability::computeDesirability(), DBG, MSSOTLPolicy::getName(), MSSOTLPolicy::myDesirabilityAlgorithm, and WRITE_MESSAGE.

§ computeDesirability() [2/2]

SUMOReal MSSOTLPolicy::computeDesirability ( SUMOReal  vehInMeasure,
SUMOReal  vehOutMeasure 
)
inherited

§ decideNextPhase()

int MSSOTLPolicy::decideNextPhase ( SUMOTime  elapsed,
const MSPhaseDefinition stage,
int  currentPhaseIndex,
int  phaseMaxCTS,
bool  thresholdPassed,
bool  pushButtonPressed,
int  vehicleCount 
)
virtualinherited

§ getDesirabilityAlgorithm()

§ getMap()

§ getName()

§ getParameter()

const std::string & Parameterised::getParameter ( const std::string &  key,
const std::string &  defaultValue 
) const
inherited

Returns the value for a given key.

Parameters
[in]keyThe key to ask for
[in]defaultValueThe default value to return if no value is stored under the key
Returns
The value stored under the key

Definition at line 81 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by MSTLLogicControl::WAUTSwitchProcedure_Stretch::adaptLogic(), MSDevice_Battery::buildVehicleDevices(), MSDevice_Example::buildVehicleDevices(), MSDevice::equippedByDefaultAssignmentOptions(), MSSOTLTrafficLightLogic::getDecayConstant(), MSTLLogicControl::WAUTSwitchProcedure::getGSPValue(), MSSOTLTrafficLightLogic::getInputSensorsLength(), MSSOTLRequestPolicy::getMinDecisionalPhaseDuration(), MSSOTLRequestTrafficLightLogic::getMinDecisionalPhaseDuration(), MSSOTLTrafficLightLogic::getMode(), MSSOTLTrafficLightLogic::getOutputSensorsLength(), MSSOTLTrafficLightLogic::getSpeedThreshold(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::getStretchAreaNo(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::getStretchBereichDef(), MSSOTLTrafficLightLogic::getThreshold(), PushButtonLogic::init(), MSSOTLPhasePolicy::init(), SigmoidLogic::init(), MSSOTLTrafficLightLogic::init(), MSSwarmTrafficLightLogic::init(), MSSOTLTrafficLightLogic::isDecayThresholdActivated(), MSSOTLTrafficLightLogic::isPushButtonPressed(), MSActuatedTrafficLightLogic::MSActuatedTrafficLightLogic(), MSSOTLPolicy::MSSOTLPolicy(), MSSOTLPolicy5DFamilyStimulus::MSSOTLPolicy5DFamilyStimulus(), MSSwarmTrafficLightLogic::MSSwarmTrafficLightLogic(), TraCIServerAPI_Edge::processGet(), TraCIServerAPI_POI::processGet(), TraCIServerAPI_TLS::processGet(), TraCIServerAPI_VehicleType::processGet(), TraCIServerAPI_Polygon::processGet(), TraCIServerAPI_Route::processGet(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Person::processGet(), TraCIServerAPI_Lane::processGet(), MSSOTLPolicyDesirability::readParameter(), MSTLLogicControl::WAUTSwitchProcedure_Stretch::stretchLogic(), and TraCIServerAPI_Vehicle::vtdMap().

§ getThetaSensitivity()

virtual SUMOReal MSSOTLPolicy::getThetaSensitivity ( )
inlinevirtualinherited

§ init() [1/3]

void PushButtonLogic::init ( std::string  prefix,
const Parameterised parameterised 
)
protectedinherited

§ init() [2/3]

void MSSOTLPlatoonPolicy::init ( )
protectedvirtual

Reimplemented from MSSOTLPolicy.

Definition at line 69 of file MSSOTLPlatoonPolicy.cpp.

References PushButtonLogic::init(), and SigmoidLogic::init().

Referenced by MSSOTLPlatoonPolicy().

§ init() [3/3]

void SigmoidLogic::init ( std::string  prefix,
const Parameterised parameterised 
)
protectedinherited

§ knowsParameter()

bool Parameterised::knowsParameter ( const std::string &  key) const
inherited

Returns whether the parameter is known.

Parameters
[in]keyThe key to ask for
Returns
Whether the key is known

Definition at line 75 of file Parameterised.cpp.

References Parameterised::myMap.

Referenced by MSDevice_Example::buildVehicleDevices(), and MSDevice::equippedByDefaultAssignmentOptions().

§ pushButtonLogic()

bool PushButtonLogic::pushButtonLogic ( SUMOTime  elapsed,
bool  pushButtonPressed,
const MSPhaseDefinition stage 
)
protectedinherited

§ setThetaSensitivity()

virtual void MSSOTLPolicy::setThetaSensitivity ( SUMOReal  val)
inlinevirtualinherited

Definition at line 122 of file MSSOTLPolicy.h.

Referenced by MSSwarmTrafficLightLogic::updateSensitivities().

§ sigmoidLogic()

bool SigmoidLogic::sigmoidLogic ( SUMOTime  elapsed,
const MSPhaseDefinition stage,
int  vehicleCount 
)
protectedinherited

Field Documentation

§ m_k

SUMOReal SigmoidLogic::m_k
protectedinherited

Definition at line 63 of file MSSOTLPolicy.h.

§ m_prefix [1/2]

std::string PushButtonLogic::m_prefix
protectedinherited

§ m_prefix [2/2]

std::string SigmoidLogic::m_prefix
protectedinherited

Definition at line 64 of file MSSOTLPolicy.h.

§ m_pushButtonScaleFactor

SUMOReal PushButtonLogic::m_pushButtonScaleFactor
protectedinherited

Definition at line 52 of file MSSOTLPolicy.h.

Referenced by PushButtonLogic::init(), and PushButtonLogic::pushButtonLogic().

§ m_useSigmoid

bool SigmoidLogic::m_useSigmoid
protectedinherited

Definition at line 62 of file MSSOTLPolicy.h.


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