Eclipse SUMO - Simulation of Urban MObility
TraCIAPI::TrafficLightScope Class Reference

Scope for interaction with traffic lights. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::TrafficLightScope:
Collaboration diagram for TraCIAPI::TrafficLightScope:

Public Member Functions

void clearSubscriptionResults ()
 
const libsumo::ContextSubscriptionResults getAllContextSubscriptionResults () const
 
const libsumo::SubscriptionResults getAllSubscriptionResults () const
 
std::vector< libsumo::TraCILogicgetCompleteRedYellowGreenDefinition (const std::string &tlsID) const
 
const libsumo::SubscriptionResults getContextSubscriptionResults (const std::string &objID) const
 
std::vector< std::string > getControlledLanes (const std::string &tlsID) const
 
std::vector< std::vector< libsumo::TraCILink > > getControlledLinks (const std::string &tlsID) const
 
int getIDCount () const
 
std::vector< std::string > getIDList () const
 
libsumo::SubscriptionResultsgetModifiableContextSubscriptionResults (const std::string &objID)
 
libsumo::SubscriptionResultsgetModifiableSubscriptionResults ()
 
double getNextSwitch (const std::string &tlsID) const
 
std::string getParameter (const std::string &objectID, const std::string &key) const
 retrieve generic paramter More...
 
int getPhase (const std::string &tlsID) const
 
double getPhaseDuration (const std::string &tlsID) const
 
std::string getPhaseName (const std::string &tlsID) const
 
std::string getProgram (const std::string &tlsID) const
 
std::string getRedYellowGreenState (const std::string &tlsID) const
 
const libsumo::TraCIResults getSubscriptionResults (const std::string &objID) const
 
void setCompleteRedYellowGreenDefinition (const std::string &tlsID, const libsumo::TraCILogic &logic) const
 
void setParameter (const std::string &objectID, const std::string &key, const std::string &value) const
 set generic paramter More...
 
void setPhase (const std::string &tlsID, int index) const
 
void setPhaseDuration (const std::string &tlsID, double phaseDuration) const
 
void setPhaseName (const std::string &tlsID, const std::string &name) const
 
void setProgram (const std::string &tlsID, const std::string &programID) const
 
void setRedYellowGreenState (const std::string &tlsID, const std::string &state) const
 
void subscribe (const std::string &objID, const std::vector< int > &vars, double beginTime, double endTime) const
 
void subscribeContext (const std::string &objID, int domain, double range, const std::vector< int > &vars, double beginTime, double endTime) const
 
 TrafficLightScope (TraCIAPI &parent)
 
virtual ~TrafficLightScope ()
 

Protected Attributes

int myCmdGetID
 
int myCmdSetID
 
int myContextSubscribeID
 
libsumo::ContextSubscriptionResults myContextSubscriptionResults
 
TraCIAPImyParent
 The parent TraCI client which offers the connection. More...
 
int mySubscribeID
 
libsumo::SubscriptionResults mySubscriptionResults
 

Private Member Functions

TrafficLightScopeoperator= (const TrafficLightScope &src)
 invalidated assignment operator More...
 
 TrafficLightScope (const TrafficLightScope &src)
 invalidated copy constructor More...
 

Detailed Description

Scope for interaction with traffic lights.

Definition at line 556 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ TrafficLightScope() [1/2]

TraCIAPI::TrafficLightScope::TrafficLightScope ( TraCIAPI parent)
inline

Definition at line 558 of file TraCIAPI.h.

◆ ~TrafficLightScope()

virtual TraCIAPI::TrafficLightScope::~TrafficLightScope ( )
inlinevirtual

Definition at line 559 of file TraCIAPI.h.

References TraCIAPI::TraCIScopeWrapper::operator=().

◆ TrafficLightScope() [2/2]

TraCIAPI::TrafficLightScope::TrafficLightScope ( const TrafficLightScope src)
private

invalidated copy constructor

Member Function Documentation

◆ clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )
inherited

Definition at line 3667 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getAllContextSubscriptionResults()

const libsumo::ContextSubscriptionResults TraCIAPI::TraCIScopeWrapper::getAllContextSubscriptionResults ( ) const
inherited

Definition at line 3651 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getAllSubscriptionResults()

const libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::getAllSubscriptionResults ( ) const
inherited

Definition at line 3635 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getCompleteRedYellowGreenDefinition()

std::vector< libsumo::TraCILogic > TraCIAPI::TrafficLightScope::getCompleteRedYellowGreenDefinition ( const std::string &  tlsID) const

◆ getContextSubscriptionResults()

const libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::getContextSubscriptionResults ( const std::string &  objID) const
inherited

◆ getControlledLanes()

std::vector< std::string > TraCIAPI::TrafficLightScope::getControlledLanes ( const std::string &  tlsID) const

Definition at line 1916 of file TraCIAPI.cpp.

References libsumo::CMD_GET_TL_VARIABLE, and libsumo::TL_CONTROLLED_LANES.

Referenced by TraCITestClient::testAPI().

◆ getControlledLinks()

std::vector< std::vector< libsumo::TraCILink > > TraCIAPI::TrafficLightScope::getControlledLinks ( const std::string &  tlsID) const

◆ getIDCount()

int TraCIAPI::TrafficLightScope::getIDCount ( ) const

Definition at line 1853 of file TraCIAPI.cpp.

References libsumo::CMD_GET_TL_VARIABLE, and libsumo::ID_COUNT.

Referenced by TraCITestClient::testAPI().

◆ getIDList()

std::vector< std::string > TraCIAPI::TrafficLightScope::getIDList ( ) const

Definition at line 1848 of file TraCIAPI.cpp.

References libsumo::CMD_GET_TL_VARIABLE, and libsumo::TRACI_ID_LIST.

Referenced by TraCITestClient::testAPI().

◆ getModifiableContextSubscriptionResults()

libsumo::SubscriptionResults & TraCIAPI::TraCIScopeWrapper::getModifiableContextSubscriptionResults ( const std::string &  objID)
inherited

Definition at line 3680 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getModifiableSubscriptionResults()

libsumo::SubscriptionResults & TraCIAPI::TraCIScopeWrapper::getModifiableSubscriptionResults ( )
inherited

Definition at line 3674 of file TraCIAPI.cpp.

Referenced by TraCIAPI::TraCIScopeWrapper::~TraCIScopeWrapper().

◆ getNextSwitch()

double TraCIAPI::TrafficLightScope::getNextSwitch ( const std::string &  tlsID) const

Definition at line 1969 of file TraCIAPI.cpp.

References libsumo::CMD_GET_TL_VARIABLE, and libsumo::TL_NEXT_SWITCH.

Referenced by TraCITestClient::testAPI().

◆ getParameter()

std::string TraCIAPI::TraCIScopeWrapper::getParameter ( const std::string &  objectID,
const std::string &  key 
) const
inherited

◆ getPhase()

int TraCIAPI::TrafficLightScope::getPhase ( const std::string &  tlsID) const

Definition at line 1954 of file TraCIAPI.cpp.

References libsumo::CMD_GET_TL_VARIABLE, and libsumo::TL_CURRENT_PHASE.

Referenced by TraCITestClient::testAPI().

◆ getPhaseDuration()

double TraCIAPI::TrafficLightScope::getPhaseDuration ( const std::string &  tlsID) const

Definition at line 1964 of file TraCIAPI.cpp.

References libsumo::CMD_GET_TL_VARIABLE, and libsumo::TL_PHASE_DURATION.

Referenced by TraCITestClient::testAPI().

◆ getPhaseName()

std::string TraCIAPI::TrafficLightScope::getPhaseName ( const std::string &  tlsID) const

Definition at line 1959 of file TraCIAPI.cpp.

References libsumo::CMD_GET_TL_VARIABLE, and libsumo::VAR_NAME.

Referenced by TraCITestClient::testAPI().

◆ getProgram()

std::string TraCIAPI::TrafficLightScope::getProgram ( const std::string &  tlsID) const

Definition at line 1949 of file TraCIAPI.cpp.

References libsumo::CMD_GET_TL_VARIABLE, and libsumo::TL_CURRENT_PROGRAM.

Referenced by TraCITestClient::testAPI().

◆ getRedYellowGreenState()

std::string TraCIAPI::TrafficLightScope::getRedYellowGreenState ( const std::string &  tlsID) const

◆ getSubscriptionResults()

const libsumo::TraCIResults TraCIAPI::TraCIScopeWrapper::getSubscriptionResults ( const std::string &  objID) const
inherited

◆ operator=()

TrafficLightScope& TraCIAPI::TrafficLightScope::operator= ( const TrafficLightScope src)
private

invalidated assignment operator

◆ setCompleteRedYellowGreenDefinition()

◆ setParameter()

void TraCIAPI::TraCIScopeWrapper::setParameter ( const std::string &  objectID,
const std::string &  key,
const std::string &  value 
) const
inherited

◆ setPhase()

void TraCIAPI::TrafficLightScope::setPhase ( const std::string &  tlsID,
int  index 
) const

◆ setPhaseDuration()

void TraCIAPI::TrafficLightScope::setPhaseDuration ( const std::string &  tlsID,
double  phaseDuration 
) const

◆ setPhaseName()

void TraCIAPI::TrafficLightScope::setPhaseName ( const std::string &  tlsID,
const std::string &  name 
) const

◆ setProgram()

void TraCIAPI::TrafficLightScope::setProgram ( const std::string &  tlsID,
const std::string &  programID 
) const

◆ setRedYellowGreenState()

void TraCIAPI::TrafficLightScope::setRedYellowGreenState ( const std::string &  tlsID,
const std::string &  state 
) const

◆ subscribe()

void TraCIAPI::TraCIScopeWrapper::subscribe ( const std::string &  objID,
const std::vector< int > &  vars,
double  beginTime,
double  endTime 
) const
inherited

◆ subscribeContext()

void TraCIAPI::TraCIScopeWrapper::subscribeContext ( const std::string &  objID,
int  domain,
double  range,
const std::vector< int > &  vars,
double  beginTime,
double  endTime 
) const
inherited

Field Documentation

◆ myCmdGetID

int TraCIAPI::TraCIScopeWrapper::myCmdGetID
protectedinherited

Definition at line 146 of file TraCIAPI.h.

◆ myCmdSetID

int TraCIAPI::TraCIScopeWrapper::myCmdSetID
protectedinherited

Definition at line 147 of file TraCIAPI.h.

◆ myContextSubscribeID

int TraCIAPI::TraCIScopeWrapper::myContextSubscribeID
protectedinherited

Definition at line 149 of file TraCIAPI.h.

◆ myContextSubscriptionResults

libsumo::ContextSubscriptionResults TraCIAPI::TraCIScopeWrapper::myContextSubscriptionResults
protectedinherited

Definition at line 151 of file TraCIAPI.h.

◆ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent
protectedinherited

The parent TraCI client which offers the connection.

Definition at line 145 of file TraCIAPI.h.

◆ mySubscribeID

int TraCIAPI::TraCIScopeWrapper::mySubscribeID
protectedinherited

Definition at line 148 of file TraCIAPI.h.

◆ mySubscriptionResults

libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::mySubscriptionResults
protectedinherited

Definition at line 150 of file TraCIAPI.h.


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