SUMO - Simulation of Urban MObility
MSTrafficLightLogic Class Referenceabstract

The parent class for traffic light logics. More...

#include <MSTrafficLightLogic.h>

Inheritance diagram for MSTrafficLightLogic:
Named Parameterised MSOffTrafficLightLogic MSSimpleTrafficLightLogic MSActuatedTrafficLightLogic MSAgentbasedTrafficLightLogic

Data Structures

class  SwitchCommand
 Class realising the switch between the traffic light phases. More...
 

Public Types

Structure definitions
typedef std::vector< MSPhaseDefinition * > Phases
 Definition of a list of phases, being the junction logic. More...
 
typedef std::vector< MSLink * > LinkVector
 Definition of the list of links that participate in this tl-light. More...
 
typedef std::vector< LinkVectorLinkVectorVector
 Definition of a list that holds lists of links that do have the same attribute. More...
 
typedef std::vector< MSLane * > LaneVector
 Definition of the list of links that participate in this tl-light. More...
 
typedef std::vector< LaneVectorLaneVectorVector
 Definition of a list that holds lists of links that do have the same attribute. More...
 

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...
 
void addTo (const StoringVisitor &cont) const
 Adds this object to the given container. More...
 
void clearParameter ()
 Clears the parameter map. More...
 
const std::string & getID () const
 Returns the id. More...
 
const std::map< std::string, std::string > & getMap () const
 Returns the inner key/value map. More...
 
const std::string & getParameter (const std::string &key, const std::string &defaultValue) const
 Returns the value for a given key. More...
 
virtual void init (NLDetectorBuilder &nb)
 Initialises the tls with information about incoming lanes. More...
 
bool knowsParameter (const std::string &key) const
 Returns whether the parameter is known. More...
 
 MSTrafficLightLogic (MSTLLogicControl &tlcontrol, const std::string &id, const std::string &programID, SUMOTime delay, const std::map< std::string, std::string > &parameters)
 Constructor. More...
 
void setID (const std::string &newID)
 resets the id More...
 
virtual ~MSTrafficLightLogic ()
 Destructor. More...
 
Handling of controlled links
void addLink (MSLink *link, MSLane *lane, unsigned int pos)
 Adds a link on building. More...
 
virtual void adaptLinkInformationFrom (const MSTrafficLightLogic &logic)
 Applies information about controlled links and lanes from the given logic. More...
 
std::map< MSLink *, LinkStatecollectLinkStates () const
 Returns the (uncontrolled) states of the controlled links. More...
 
void resetLinkStates (const std::map< MSLink *, LinkState > &vals) const
 Resets the states of controlled links. More...
 
Switching and setting current rows
virtual SUMOTime trySwitch (bool isActive)=0
 Switches to the next phase. More...
 
bool setTrafficLightSignals (SUMOTime t) const
 Applies the current signal states to controlled links. More...
 
Static Information Retrieval
const std::string & getProgramID () const
 Returns this tl-logic's id. More...
 
const LaneVectorVectorgetLaneVectors () const
 Returns the list of lists of all lanes controlled by this tls. More...
 
const LaneVectorgetLanesAt (unsigned int i) const
 Returns the list of lanes that are controlled by the signals at the given position. More...
 
const LinkVectorVectorgetLinks () const
 Returns the list of lists of all affected links. More...
 
const LinkVectorgetLinksAt (unsigned int i) const
 Returns the list of links that are controlled by the signals at the given position. More...
 
int getLinkIndex (const MSLink *const link) const
 Returns the index of the given link. More...
 
virtual unsigned int getPhaseNumber () const =0
 Returns the number of phases. More...
 
virtual const PhasesgetPhases () const =0
 Returns the phases of this tls program. More...
 
virtual const MSPhaseDefinitiongetPhase (unsigned int givenstep) const =0
 Returns the definition of the phase from the given position within the plan. More...
 
Dynamic Information Retrieval
virtual unsigned int getCurrentPhaseIndex () const =0
 Returns the current index within the program. More...
 
virtual const MSPhaseDefinitiongetCurrentPhaseDef () const =0
 Returns the definition of the current phase. More...
 
SUMOTime getDefaultCycleTime () const
 Returns the cycle time (in ms) More...
 
SUMOTime getNextSwitchTime () const
 Returns the assumed next switch time. More...
 
Conversion between time and phase
virtual SUMOTime getPhaseIndexAtTime (SUMOTime simStep) const =0
 Returns the index of the logic at the given simulation step. More...
 
virtual SUMOTime getOffsetFromIndex (unsigned int index) const =0
 Returns the position (start of a phase during a cycle) from of a given step. More...
 
virtual unsigned int getIndexFromOffset (SUMOTime offset) const =0
 Returns the step (the phasenumber) of a given position of the cycle. More...
 
Changing phases and phase durations
void addOverridingDuration (SUMOTime duration)
 Changes the duration of the next phase. More...
 
void setCurrentDurationIncrement (SUMOTime delay)
 Delays current phase by the given delay. More...
 
virtual void changeStepAndDuration (MSTLLogicControl &tlcontrol, SUMOTime simStep, unsigned int step, SUMOTime stepDuration)=0
 Changes the current phase and her duration. More...
 

Protected Attributes

SUMOTime myCurrentDurationIncrement
 A value for enlarge the current duration. More...
 
SUMOTime myDefaultCycleTime
 The cycle time (without changes) More...
 
std::string myID
 The name of the object. More...
 
LaneVectorVector myLanes
 The list of links which do participate in this traffic light. More...
 
LinkVectorVector myLinks
 The list of links which do participate in this traffic light. More...
 
std::vector< SUMOTimemyOverridingTimes
 A list of duration overrides. More...
 
std::string myProgramID
 The id of the logic. More...
 
SwitchCommandmySwitchCommand
 The current switch command. More...
 

Private Member Functions

 MSTrafficLightLogic (const MSTrafficLightLogic &s)
 invalidated copy constructor More...
 
MSTrafficLightLogicoperator= (const MSTrafficLightLogic &s)
 invalidated assignment operator More...
 

Detailed Description

The parent class for traffic light logics.

Definition at line 63 of file MSTrafficLightLogic.h.

Member Typedef Documentation

typedef std::vector<MSLane*> MSTrafficLightLogic::LaneVector

Definition of the list of links that participate in this tl-light.

Definition at line 78 of file MSTrafficLightLogic.h.

Definition of a list that holds lists of links that do have the same attribute.

Definition at line 81 of file MSTrafficLightLogic.h.

typedef std::vector<MSLink*> MSTrafficLightLogic::LinkVector

Definition of the list of links that participate in this tl-light.

Definition at line 72 of file MSTrafficLightLogic.h.

Definition of a list that holds lists of links that do have the same attribute.

Definition at line 75 of file MSTrafficLightLogic.h.

Definition of a list of phases, being the junction logic.

Definition at line 69 of file MSTrafficLightLogic.h.

Constructor & Destructor Documentation

MSTrafficLightLogic::MSTrafficLightLogic ( MSTLLogicControl tlcontrol,
const std::string &  id,
const std::string &  programID,
SUMOTime  delay,
const std::map< std::string, std::string > &  parameters 
)

Constructor.

Parameters
[in]tlcontrolThe tls control responsible for this tls
[in]idThis tls' id
[in]programIDThis tls' sub-id (program id)
[in]delayThe time to wait before the first switch

Definition at line 103 of file MSTrafficLightLogic.cpp.

References MSEventControl::addEvent(), MSNet::getBeginOfTimestepEvents(), MSNet::getInstance(), mySwitchCommand, and MSEventControl::NO_CHANGE.

MSTrafficLightLogic::~MSTrafficLightLogic ( )
virtual

Destructor.

Definition at line 144 of file MSTrafficLightLogic.cpp.

MSTrafficLightLogic::MSTrafficLightLogic ( const MSTrafficLightLogic s)
private

invalidated copy constructor

Member Function Documentation

void MSTrafficLightLogic::adaptLinkInformationFrom ( const MSTrafficLightLogic logic)
virtual

Applies information about controlled links and lanes from the given logic.

If we load a logic after the network has been loaded, we do not get the information about controlled links afterwards. We have to copy them from a previously loaded logic.

Parameters
[in]logicThe logic to use the information about controlled links/lanes from

Reimplemented in MSOffTrafficLightLogic.

Definition at line 170 of file MSTrafficLightLogic.cpp.

References myLanes, and myLinks.

Referenced by MSOffTrafficLightLogic::adaptLinkInformationFrom(), and MSTLLogicControl::TLSLogicVariants::addLogic().

void MSTrafficLightLogic::addLink ( MSLink link,
MSLane lane,
unsigned int  pos 
)

Adds a link on building.

Parameters
[in]linkThe controlled link
[in]laneThe lane this link starts at
[in]posThe link's index (signal group) within this program

Definition at line 152 of file MSTrafficLightLogic.cpp.

References getCurrentPhaseDef(), MSNet::getInstance(), myLanes, myLinks, and MSLink::setTLState().

void MSTrafficLightLogic::addOverridingDuration ( SUMOTime  duration)

Changes the duration of the next phase.

Parameters
[in]durationThe new duration

Definition at line 243 of file MSTrafficLightLogic.cpp.

References myOverridingTimes.

void Parameterised::addParameter ( const std::string &  key,
const std::string &  value 
)
inherited
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.

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.

void Named::addTo ( const StoringVisitor cont) const
inlineinherited

Adds this object to the given container.

Parameters

Definition at line 121 of file Named.h.

References Named::StoringVisitor::add().

virtual void MSTrafficLightLogic::changeStepAndDuration ( MSTLLogicControl tlcontrol,
SUMOTime  simStep,
unsigned int  step,
SUMOTime  stepDuration 
)
pure virtual

Changes the current phase and her duration.

Parameters
[in]tlcontrolThe responsible traffic lights control
[in]simStepThe current simulation step
[in]stepIndex of the phase to use
[in]stepDurationThe left duration of the phase

Implemented in MSOffTrafficLightLogic, and MSSimpleTrafficLightLogic.

Referenced by TraCIServerAPI_TLS::processSet(), and MSTLLogicControl::WAUTSwitchProcedure::switchToPos().

void Parameterised::clearParameter ( )
inherited

Clears the parameter map.

Definition at line 91 of file Parameterised.cpp.

References Parameterised::myMap.

std::map< MSLink *, LinkState > MSTrafficLightLogic::collectLinkStates ( ) const

Returns the (uncontrolled) states of the controlled links.

Returns
The controlled link's states

Definition at line 177 of file MSTrafficLightLogic.cpp.

References myLinks.

virtual unsigned int MSTrafficLightLogic::getCurrentPhaseIndex ( ) const
pure virtual
SUMOTime MSTrafficLightLogic::getDefaultCycleTime ( ) const
inline

Returns the cycle time (in ms)

Returns
The (maybe changing) cycle time of this tls

Definition at line 259 of file MSTrafficLightLogic.h.

References myDefaultCycleTime.

Referenced by MSTLLogicControl::WAUTSwitchProcedure::isPosAtGSP().

const std::string& Named::getID ( ) const
inlineinherited

Returns the id.

Returns
The stored id

Definition at line 60 of file Named.h.

References Named::myID.

Referenced by NIImporter_SUMO::_loadNetwork(), MSVehicleTransfer::add(), TraCIServerAPI_Lane::StoringVisitor::add(), Named::StoringVisitor::add(), MSDetectorControl::add(), RORouteDef::addAlternative(), MSNet::addBusStop(), NBLoadedSUMOTLDef::addConnection(), NLHandler::addConnection(), NIXMLConnectionsHandler::addCrossing(), RODFDetectorCon::addDetector(), RONet::addEdge(), ROJTREdge::addFollowerProbability(), MSTLLogicControl::TLSLogicVariants::addLogic(), RONet::addNode(), NIImporter_SUMO::addPhase(), RONet::addRouteDef(), NBDistrict::addSink(), NBDistrict::addSource(), NBTrafficLightLogic::addStep(), MSRouteHandler::addStop(), NIXMLTrafficLightsHandler::addTlConnection(), NIVissimDisturbance::addToNode(), MSVehicle::addTraciStop(), GUITrafficLightLogicWrapper::begin2TrackPhases(), MSPerson::MSPersonStage_Driving::beginEventOutput(), MSPerson::MSPersonStage_Waiting::beginEventOutput(), NIVisumTL::build(), RODFNet::buildApproachList(), MS_E2_ZS_CollectorOverLanes::buildCollector(), NBNode::buildCrossings(), NIImporter_VISUM::buildDistrictNode(), NIVissimConnection::buildEdgeConnections(), RODFNet::buildEdgeFlowMap(), NBNode::buildInnerEdges(), NBEdge::buildInnerEdges(), NGEdge::buildNBEdge(), NIVissimEdge::buildNBEdge(), NBRampsComputer::buildOffRamp(), NBRampsComputer::buildOnRamp(), NBNode::buildWalkingAreas(), MSSimpleTrafficLightLogic::changeStepAndDuration(), NBEdge::checkGeometry(), MSVehicleTransfer::checkInsertions(), ODDistrictHandler::closeDistrict(), NLHandler::closeEdge(), RORouteHandler::closeRouteDistribution(), RORouteHandler::closeVehicle(), NBTrafficLightDefinition::collectAllLinks(), NBTrafficLightDefinition::collectEdges(), ROJTRRouter::compute(), NBTrafficLightDefinition::compute(), NBNode::computeInternalLaneShape(), NBEdge::computeLaneShapes(), NBNode::computeLogic(), NBNode::computeNodeShape(), RODFNet::computeRoutesFor(), NBTrafficLightLogicCont::computeSingleLogic(), NBTurningDirectionsComputer::computeTurnDirectionsForNode(), NGNet::connect(), MSAbstractLaneChangeModel::continueLaneChangeManeuver(), NLDetectorBuilder::convUncontE2PosLength(), GUINet::createTLWrapper(), MSLane::detectCollisions(), NIVissimDistrictConnection::dict_BuildDistricts(), MSPerson::MSPersonStage_Driving::endEventOutput(), MSPerson::MSPersonStage_Waiting::endEventOutput(), MSE3Collector::enter(), MSCalibrator::execute(), Command_SaveTLSState::execute(), Command_SaveTLSSwitchStates::execute(), Command_SaveTLSSwitches::execute(), MSVTypeProbe::execute(), MSPModel_Striping::MovePedestrians::execute(), MSVehicle::executeMove(), MSLane::executeMovements(), NBNodeCont::extract(), NBTrafficLightLogicCont::extract(), NBEdgeCont::extract(), RODFDetectorCon::getAggFlowFor(), RODFDetectorCon::getAnyDetectorForEdge(), MSNet::getBusStopID(), NBEdge::getCrossingAngle(), RODFNet::getDetectorEdge(), MSMeanData::getEdgeID(), PedestrianEdge< E, L, N >::getEffort(), NBEdge::getFirstNonPedestrianLane(), MS_E2_ZS_CollectorOverLanes::getLanePredeccessorLanes(), AGStreet::getName(), NIImporter_VISUM::getNamedEdgeContinuating(), MSPModel_Striping::getNextLane(), GUIVehicle::getParameterWindow(), GUITrafficLightLogicWrapper::getPopUpMenu(), NLTriggerBuilder::getPosition(), NLDetectorBuilder::getPositionChecking(), NBNode::getPossiblySplittedIncoming(), NBNode::getPossiblySplittedOutgoing(), NIImporter_VISUM::getReversedContinuating(), NBNode::guessCrossings(), RODFDetectorCon::guessEmptyFlows(), NBNodeCont::guessTLs(), GUITLLogicPhasesTrackerWindow::GUITLLogicPhasesTrackerWindow(), NBEdgeCont::ignoreFilterMatch(), MSActuatedTrafficLightLogic::init(), MSAgentbasedTrafficLightLogic::init(), init(), PedestrianEdge< E, L, N >::initPedestrianNetwork(), NIImporter_SUMO::initTrafficLightLogic(), NIXMLTrafficLightsHandler::initTrafficLightLogic(), NBDistrictCont::insert(), NBTrafficLightLogicCont::insert(), NBNodeCont::insert(), NBEdgeCont::insert(), NBNode::invalidateTLS(), MSTLLogicControl::isActive(), RODFNet::isDestination(), RODFNet::isFalseSource(), RODFNet::isSource(), NBEdgeCont::joinSameNodeConnectingEdges(), MSE3Collector::leave(), NIImporter_OpenDrive::loadNetwork(), NBRampsComputer::moveRampRight(), MSPModel_Striping::PState::moveToNextLane(), MSCalibrator::MSCalibrator(), MSPerson::MSPersonStage_Waiting::MSPersonStage_Waiting(), NBOwnTLDef::myCompute(), NBLoadedTLDef::myCompute(), NIXMLTrafficLightsHandler::myEndElement(), NIXMLEdgesHandler::myEndElement(), NIImporter_SUMO::myEndElement(), NIXMLConnectionsHandler::myStartElement(), MSLaneSpeedTrigger::myStartElement(), MSTriggeredRerouter::myStartElement(), NBConnection::NBConnection(), NBRequest::NBRequest(), MSDevice_BTreceiver::notifyEnter(), MSDevice_Tripinfo::notifyEnter(), MSDevice_BTsender::notifyEnter(), MSDevice_Example::notifyEnter(), MSCalibrator::VehicleRemover::notifyEnter(), MSDevice_Tripinfo::notifyLeave(), MSDevice_Person::notifyLeave(), MSDevice_Example::notifyLeave(), MSDevice_BTreceiver::notifyLeave(), MSDevice_BTsender::notifyLeave(), MSDevice_Example::notifyMove(), MSDevice_BTreceiver::notifyMove(), MSDevice_BTsender::notifyMove(), GUIViewTraffic::onGamingClick(), RORouteHandler::openRoute(), Named::ComparatorIdLess::operator()(), NBTurningDirectionsComputer::combination_by_angle_sorter::operator()(), RODFNet::idComp::operator()(), NBOwnTLDef::edge_by_incoming_priority_sorter::operator()(), NBNetBuilder::by_id_sorter::operator()(), NBContHelper::same_connection_edge_sorter::operator()(), MSEdge::by_id_sorter::operator()(), NBNode::nodes_by_id_sorter::operator()(), NIImporter_VISUM::parse_EdgePolys(), NIImporter_VISUM::parse_Lanes(), NIImporter_VISUM::parse_LanesConnections(), NIImporter_VISUM::parse_Turns(), NIImporter_VISUM::parse_TurnsToSignalGroups(), NIXMLConnectionsHandler::parseDeprecatedLaneDefinition(), NIXMLConnectionsHandler::parseLaneBound(), NBLoadedSUMOTLDef::patchIfCrossingsAdded(), MSLCM_JE2013::patchSpeed(), NBLoadedTLDef::SignalGroup::patchTYellow(), MSRightOfWayJunction::postloadInit(), AGStreet::print(), TraCIServerAPI_InductionLoop::processGet(), TraCIServerAPI_TLS::processGet(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Lane::processGet(), TraCIServerAPI_Vehicle::processSet(), NWWriter_SUMO::prohibitionConnection(), MSPModel_Striping::PState::PState(), NBEdgeCont::recheckPostProcessConnections(), NBLoadedTLDef::SignalGroup::remapIncoming(), NBLoadedTLDef::SignalGroup::remapOutgoing(), NBLoadedSUMOTLDef::removeConnection(), MSCalibrator::removePending(), NBNode::removeSelfLoops(), NBEdgeCont::removeUnwishedEdges(), NBNodeCont::removeUnwishedNodes(), NBNodeCont::rename(), NBEdgeCont::rename(), NBConnection::replaceFrom(), MSBaseVehicle::replaceRouteEdges(), NBConnection::replaceTo(), NIImporter_DlrNavteq::TrafficlightsHandler::report(), NIXMLTrafficLightsHandler::retrieveLaneIndex(), RODFNet::revalidateFlows(), PCPolyContainer::save(), RONet::saveAndRemoveRoutesUntil(), MSBaseVehicle::saveState(), NBNodeCont::setAsTLControlled(), NBEdge::setControllingTLInformation(), NIXMLEdgesHandler::setNodes(), MSLink::setRequestInformation(), NBOwnTLDef::setTLControllingInformation(), NBLoadedSUMOTLDef::setTLControllingInformation(), NBLoadedTLDef::setTLControllingInformation(), NBEdgeCont::splitAt(), MSLane::succLinkSec(), GUITrafficLightLogicWrapper::switchTLSLogic(), MSDevice_BTreceiver::BTreceiverUpdate::updateVisibility(), TraCIServerAPI_Vehicle::vtdMap_matchingEdgeLane(), TraCIServerAPI_Vehicle::vtdMap_matchingRoutePosition(), MSLCM_JE2013::wantsChange(), MSFCDExport::write(), MSEmissionExport::write(), MSInstantInductLoop::write(), NBSign::writeAsPOI(), NWWriter_SUMO::writeConnection(), NWWriter_SUMO::writeDistrict(), MSFullExport::writeEdge(), MSXMLRawOut::writeEdge(), NWWriter_SUMO::writeEdge(), MSMeanData::writeEdge(), NWWriter_XML::writeEdgesAndConnections(), RODFDetector::writeEmitterDefinition(), RODFDetectorCon::writeEmitterPOIs(), RODFDetectorCon::writeEmitters(), RODFDetectorCon::writeEndRerouterDetectors(), NWWriter_SUMO::writeInternalConnections(), NWWriter_SUMO::writeJunction(), MSQueueExport::writeLane(), MSFullExport::writeLane(), NWWriter_DlrNavteq::writeLinksUnsplitted(), NWWriter_OpenDrive::writeNetwork(), NWWriter_XML::writeNodes(), NWWriter_DlrNavteq::writeNodesUnsplitted(), NWWriter_SUMO::writeRoundabout(), RODFDetectorCon::writeSpeedTrigger(), NWWriter_DlrNavteq::writeTrafficSignals(), MSInductLoop::writeTypedXMLOutput(), RODFDetectorCon::writeValidationDetectors(), MSFullExport::writeVehicles(), MSRouteProbe::writeXMLOutput(), and MSE2Collector::writeXMLOutput().

virtual unsigned int MSTrafficLightLogic::getIndexFromOffset ( SUMOTime  offset) const
pure virtual

Returns the step (the phasenumber) of a given position of the cycle.

Parameters
[in]offsetThe offset (time) for which the according phase shall be returned
Returns
The according phase

Implemented in MSOffTrafficLightLogic, and MSSimpleTrafficLightLogic.

Referenced by MSTLLogicControl::WAUTSwitchProcedure::getDiffToStartOfPhase(), and MSTLLogicControl::WAUTSwitchProcedure::switchToPos().

const LaneVector& MSTrafficLightLogic::getLanesAt ( unsigned int  i) const
inline

Returns the list of lanes that are controlled by the signals at the given position.

Parameters
[in]iThe index of the signal
Returns
The lanes controlled by the signal at the given index

Definition at line 191 of file MSTrafficLightLogic.h.

References myLanes.

Referenced by MSAgentbasedTrafficLightLogic::collectData(), GUITrafficLightLogicWrapper::drawGL(), MSActuatedTrafficLightLogic::duration(), Command_SaveTLSSwitches::execute(), MSActuatedTrafficLightLogic::gapControl(), and GUIViewTraffic::onGamingClick().

const LaneVectorVector& MSTrafficLightLogic::getLaneVectors ( ) const
inline

Returns the list of lists of all lanes controlled by this tls.

Returns
All lanes controlled by this tls, sorted by the signal index

Definition at line 182 of file MSTrafficLightLogic.h.

References myLanes.

Referenced by GUITrafficLightLogicWrapper::getCenteringBoundary(), TraCIServerAPI_TLS::processGet(), and MSFullExport::writeTLS().

int MSTrafficLightLogic::getLinkIndex ( const MSLink *const  link) const

Returns the index of the given link.

Parameters
[in]linkThe link to retrieve the index for
Returns
The index of the given link (-1 if it is not controlled by this tls)

Definition at line 219 of file MSTrafficLightLogic.cpp.

References myLinks.

Referenced by GUITrafficLightLogicWrapper::getLinkIndex().

const LinkVectorVector& MSTrafficLightLogic::getLinks ( ) const
inline
const LinkVector& MSTrafficLightLogic::getLinksAt ( unsigned int  i) const
inline

Returns the list of links that are controlled by the signals at the given position.

Parameters
[in]iThe index of the signal
Returns
The links controlled by the signal at the given index

Definition at line 208 of file MSTrafficLightLogic.h.

References myLinks.

const std::map<std::string, std::string>& Parameterised::getMap ( ) const
inlineinherited

Returns the inner key/value map.

Returns
the inner map

Definition at line 107 of file Parameterised.h.

References Parameterised::myMap.

Referenced by NBTrafficLightDefinition::compute(), GUIVehicle::getParameterWindow(), and PCPolyContainer::save().

SUMOTime MSTrafficLightLogic::getNextSwitchTime ( ) const

Returns the assumed next switch time.

The time may change in case of adaptive/actuated traffic lights.

Returns
The assumed next switch time (simulation time)

Definition at line 236 of file MSTrafficLightLogic.cpp.

References MSTrafficLightLogic::SwitchCommand::getNextSwitchTime(), and mySwitchCommand.

Referenced by MSTLLogicControl::WAUTSwitchProcedure::isPosAtGSP(), and TraCIServerAPI_TLS::processGet().

virtual SUMOTime MSTrafficLightLogic::getOffsetFromIndex ( unsigned int  index) const
pure virtual

Returns the position (start of a phase during a cycle) from of a given step.

Parameters
[in]indexThe index of the phase to return the begin of
Returns
The begin time of the phase

Implemented in MSOffTrafficLightLogic, and MSSimpleTrafficLightLogic.

Referenced by MSTLLogicControl::WAUTSwitchProcedure::getDiffToStartOfPhase(), and MSTLLogicControl::WAUTSwitchProcedure::isPosAtGSP().

const std::string & Parameterised::getParameter ( const std::string &  key,
const std::string &  defaultValue 
) const
inherited
virtual const MSPhaseDefinition& MSTrafficLightLogic::getPhase ( unsigned int  givenstep) const
pure virtual

Returns the definition of the phase from the given position within the plan.

Parameters
[in]givenstepThe index of the phase within the plan
Returns
The definition of the phase at the given position

Implemented in MSOffTrafficLightLogic, and MSSimpleTrafficLightLogic.

Referenced by MSTLLogicControl::TLSLogicVariants::addLogic(), TraCIServerAPI_TLS::processGet(), TraCIServerAPI_TLS::processSet(), and MSTLLogicControl::WAUTSwitchProcedure::switchToPos().

virtual SUMOTime MSTrafficLightLogic::getPhaseIndexAtTime ( SUMOTime  simStep) const
pure virtual

Returns the index of the logic at the given simulation step.

Returns
The (estimated) index of the tls at the given simulation time step

Implemented in MSOffTrafficLightLogic, and MSSimpleTrafficLightLogic.

virtual unsigned int MSTrafficLightLogic::getPhaseNumber ( ) const
pure virtual

Returns the number of phases.

Returns
The number of this tls program's phases

Implemented in MSOffTrafficLightLogic, and MSSimpleTrafficLightLogic.

Referenced by TraCIServerAPI_TLS::processGet(), and TraCIServerAPI_TLS::processSet().

virtual const Phases& MSTrafficLightLogic::getPhases ( ) const
pure virtual

Returns the phases of this tls program.

Returns
The phases of this tls program

Implemented in MSOffTrafficLightLogic, and MSSimpleTrafficLightLogic.

Referenced by GUITrafficLightLogicWrapper::drawGL(), and init().

const std::string& MSTrafficLightLogic::getProgramID ( ) const
inline
void MSTrafficLightLogic::init ( NLDetectorBuilder nb)
virtual

Initialises the tls with information about incoming lanes.

Parameters
[in]nbThe detector builder
[in]edgeContinuationsInformation about edge predecessors/successors
Exceptions
ProcessErrorIf something fails on initialisation

Reimplemented in MSAgentbasedTrafficLightLogic, MSActuatedTrafficLightLogic, and MSOffTrafficLightLogic.

Definition at line 116 of file MSTrafficLightLogic.cpp.

References Named::getID(), getPhases(), getProgramID(), LINKSTATE_TL_GREEN_MAJOR, LINKSTATE_TL_GREEN_MINOR, LINKSTATE_TL_RED, MIN2(), myLanes, SVC_PEDESTRIAN, toString(), and WRITE_WARNING.

Referenced by NLJunctionControlBuilder::closeTrafficLightLogic(), MSActuatedTrafficLightLogic::init(), and MSAgentbasedTrafficLightLogic::init().

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(), MSDevice::equippedByDefaultAssignmentOptions(), and TraCIServerAPI_Vehicle::vtdMap_matchingNearest().

MSTrafficLightLogic& MSTrafficLightLogic::operator= ( const MSTrafficLightLogic s)
private

invalidated assignment operator

void MSTrafficLightLogic::resetLinkStates ( const std::map< MSLink *, LinkState > &  vals) const

Resets the states of controlled links.

Parameters
[in]valsThe state of controlled links to use

Definition at line 206 of file MSTrafficLightLogic.cpp.

References MSNet::getCurrentTimeStep(), MSNet::getInstance(), and myLinks.

void MSTrafficLightLogic::setCurrentDurationIncrement ( SUMOTime  delay)

Delays current phase by the given delay.

Parameters
[in]delayThe time by which the current phase shall be delayed

Definition at line 249 of file MSTrafficLightLogic.cpp.

References myCurrentDurationIncrement.

void Named::setID ( const std::string &  newID)
inlineinherited

resets the id

Parameters
[in]newIDThe new id of this object

Definition at line 68 of file Named.h.

References Named::myID.

Referenced by NBNodeCont::rename(), and NBEdgeCont::rename().

bool MSTrafficLightLogic::setTrafficLightSignals ( SUMOTime  t) const

Applies the current signal states to controlled links.

Parameters
[in]tThe current time
Returns
Always true
See also
LinkState
MSLink::setTLState

Definition at line 190 of file MSTrafficLightLogic.cpp.

References getCurrentPhaseDef(), MSPhaseDefinition::getState(), and myLinks.

Referenced by MSTLLogicControl::TLSLogicVariants::addLogic(), and MSSimpleTrafficLightLogic::changeStepAndDuration().

virtual SUMOTime MSTrafficLightLogic::trySwitch ( bool  isActive)
pure virtual

Switches to the next phase.

Parameters
[in]isActiveWhether this program is the currently used one
Returns
The time of the next switch

Implemented in MSAgentbasedTrafficLightLogic, MSActuatedTrafficLightLogic, MSOffTrafficLightLogic, and MSSimpleTrafficLightLogic.

Field Documentation

SUMOTime MSTrafficLightLogic::myCurrentDurationIncrement
protected

A value for enlarge the current duration.

Definition at line 402 of file MSTrafficLightLogic.h.

Referenced by setCurrentDurationIncrement(), and MSSimpleTrafficLightLogic::trySwitch().

LaneVectorVector MSTrafficLightLogic::myLanes
protected

The list of links which do participate in this traffic light.

Definition at line 396 of file MSTrafficLightLogic.h.

Referenced by adaptLinkInformationFrom(), addLink(), getLanesAt(), getLaneVectors(), MSActuatedTrafficLightLogic::init(), MSAgentbasedTrafficLightLogic::init(), and init().

LinkVectorVector MSTrafficLightLogic::myLinks
protected

The list of links which do participate in this traffic light.

Definition at line 393 of file MSTrafficLightLogic.h.

Referenced by adaptLinkInformationFrom(), addLink(), collectLinkStates(), getLinkIndex(), getLinks(), getLinksAt(), resetLinkStates(), and setTrafficLightSignals().

std::vector<SUMOTime> MSTrafficLightLogic::myOverridingTimes
protected

A list of duration overrides.

Definition at line 399 of file MSTrafficLightLogic.h.

Referenced by addOverridingDuration(), and MSSimpleTrafficLightLogic::trySwitch().

std::string MSTrafficLightLogic::myProgramID
protected

The id of the logic.

Definition at line 390 of file MSTrafficLightLogic.h.

Referenced by getProgramID(), MSActuatedTrafficLightLogic::init(), and MSAgentbasedTrafficLightLogic::init().

SwitchCommand* MSTrafficLightLogic::mySwitchCommand
protected

The current switch command.

Definition at line 405 of file MSTrafficLightLogic.h.

Referenced by MSSimpleTrafficLightLogic::changeStepAndDuration(), getNextSwitchTime(), and MSTrafficLightLogic().


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