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

Scope for interaction with polygons. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::PolygonScope:
Collaboration diagram for TraCIAPI::PolygonScope:

Public Member Functions

void add (const std::string &polygonID, const libsumo::TraCIPositionVector &shape, const libsumo::TraCIColor &c, bool fill, const std::string &type, int layer) const
 
void clearSubscriptionResults ()
 
const libsumo::ContextSubscriptionResults getAllContextSubscriptionResults () const
 
const libsumo::SubscriptionResults getAllSubscriptionResults () const
 
libsumo::TraCIColor getColor (const std::string &polygonID) const
 
const libsumo::SubscriptionResults getContextSubscriptionResults (const std::string &objID) const
 
int getIDCount () const
 
std::vector< std::string > getIDList () const
 
double getLineWidth (const std::string &polygonID) const
 
libsumo::SubscriptionResultsgetModifiableContextSubscriptionResults (const std::string &objID)
 
libsumo::SubscriptionResultsgetModifiableSubscriptionResults ()
 
std::string getParameter (const std::string &objectID, const std::string &key) const
 retrieve generic paramter More...
 
libsumo::TraCIPositionVector getShape (const std::string &polygonID) const
 
const libsumo::TraCIResults getSubscriptionResults (const std::string &objID) const
 
std::string getType (const std::string &polygonID) const
 
 PolygonScope (TraCIAPI &parent)
 
void remove (const std::string &polygonID, int layer=0) const
 
void setColor (const std::string &polygonID, const libsumo::TraCIColor &c) const
 
void setLineWidth (const std::string &polygonID, const double lineWidth) const
 
void setParameter (const std::string &objectID, const std::string &key, const std::string &value) const
 set generic paramter More...
 
void setShape (const std::string &polygonID, const libsumo::TraCIPositionVector &shape) const
 
void setType (const std::string &polygonID, const std::string &setType) 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
 
virtual ~PolygonScope ()
 

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

PolygonScopeoperator= (const PolygonScope &src)
 invalidated assignment operator More...
 
 PolygonScope (const PolygonScope &src)
 invalidated copy constructor More...
 

Detailed Description

Scope for interaction with polygons.

Definition at line 449 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ PolygonScope() [1/2]

TraCIAPI::PolygonScope::PolygonScope ( TraCIAPI parent)
inline

Definition at line 451 of file TraCIAPI.h.

◆ ~PolygonScope()

virtual TraCIAPI::PolygonScope::~PolygonScope ( )
inlinevirtual

Definition at line 452 of file TraCIAPI.h.

References TraCIAPI::getColor(), and TraCIAPI::TraCIScopeWrapper::operator=().

◆ PolygonScope() [2/2]

TraCIAPI::PolygonScope::PolygonScope ( const PolygonScope src)
private

invalidated copy constructor

Member Function Documentation

◆ add()

◆ 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().

◆ getColor()

libsumo::TraCIColor TraCIAPI::PolygonScope::getColor ( const std::string &  polygonID) const

Definition at line 1508 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POLYGON_VARIABLE, and libsumo::VAR_COLOR.

Referenced by TraCITestClient::testAPI().

◆ getContextSubscriptionResults()

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

◆ getIDCount()

int TraCIAPI::PolygonScope::getIDCount ( ) const

Definition at line 1488 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POLYGON_VARIABLE, and libsumo::ID_COUNT.

Referenced by TraCITestClient::testAPI().

◆ getIDList()

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

Definition at line 1483 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POLYGON_VARIABLE, and libsumo::TRACI_ID_LIST.

Referenced by TraCITestClient::testAPI().

◆ getLineWidth()

double TraCIAPI::PolygonScope::getLineWidth ( const std::string &  polygonID) const

Definition at line 1493 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POLYGON_VARIABLE, and libsumo::VAR_WIDTH.

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().

◆ getParameter()

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

◆ getShape()

libsumo::TraCIPositionVector TraCIAPI::PolygonScope::getShape ( const std::string &  polygonID) const

Definition at line 1503 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POLYGON_VARIABLE, and libsumo::VAR_SHAPE.

Referenced by TraCITestClient::testAPI().

◆ getSubscriptionResults()

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

◆ getType()

std::string TraCIAPI::PolygonScope::getType ( const std::string &  polygonID) const

Definition at line 1498 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POLYGON_VARIABLE, and libsumo::VAR_TYPE.

◆ operator=()

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

invalidated assignment operator

◆ remove()

void TraCIAPI::PolygonScope::remove ( const std::string &  polygonID,
int  layer = 0 
) const

◆ setColor()

void TraCIAPI::PolygonScope::setColor ( const std::string &  polygonID,
const libsumo::TraCIColor c 
) const

◆ setLineWidth()

void TraCIAPI::PolygonScope::setLineWidth ( const std::string &  polygonID,
const double  lineWidth 
) const

◆ setParameter()

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

◆ setShape()

void TraCIAPI::PolygonScope::setShape ( const std::string &  polygonID,
const libsumo::TraCIPositionVector shape 
) const

◆ setType()

void TraCIAPI::PolygonScope::setType ( const std::string &  polygonID,
const std::string &  setType 
) 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: