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

Scope for interaction with POIs. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::POIScope:
Collaboration diagram for TraCIAPI::POIScope:

Public Member Functions

void add (const std::string &poiID, double x, double y, const libsumo::TraCIColor &c, const std::string &type, int layer, const std::string &imgFile, double width, double height, double angle) const
 
void clearSubscriptionResults ()
 
const libsumo::ContextSubscriptionResults getAllContextSubscriptionResults () const
 
const libsumo::SubscriptionResults getAllSubscriptionResults () const
 
double getAngle (const std::string &poiID) const
 
libsumo::TraCIColor getColor (const std::string &poiID) const
 
const libsumo::SubscriptionResults getContextSubscriptionResults (const std::string &objID) const
 
double getHeight (const std::string &poiID) const
 
int getIDCount () const
 
std::vector< std::string > getIDList () const
 
std::string getImageFile (const std::string &poiID) 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::TraCIPosition getPosition (const std::string &poiID) const
 
const libsumo::TraCIResults getSubscriptionResults (const std::string &objID) const
 
std::string getType (const std::string &poiID) const
 
double getWidth (const std::string &poiID) const
 
 POIScope (TraCIAPI &parent)
 
void remove (const std::string &poiID, int layer=0) const
 
void setAngle (const std::string &poiID, double angle) const
 
void setColor (const std::string &poiID, const libsumo::TraCIColor &c) const
 
void setHeight (const std::string &poiID, double height) const
 
void setImageFile (const std::string &poiID, const std::string &imageFile) const
 
void setParameter (const std::string &objectID, const std::string &key, const std::string &value) const
 set generic paramter More...
 
void setPosition (const std::string &poiID, double x, double y) const
 
void setType (const std::string &poiID, const std::string &setType) const
 
void setWidth (const std::string &poiID, double width) 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 ~POIScope ()
 

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

POIScopeoperator= (const POIScope &src)
 invalidated assignment operator More...
 
 POIScope (const POIScope &src)
 invalidated copy constructor More...
 

Detailed Description

Scope for interaction with POIs.

Definition at line 407 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ POIScope() [1/2]

TraCIAPI::POIScope::POIScope ( TraCIAPI parent)
inline

Definition at line 409 of file TraCIAPI.h.

◆ ~POIScope()

virtual TraCIAPI::POIScope::~POIScope ( )
inlinevirtual

Definition at line 410 of file TraCIAPI.h.

◆ POIScope() [2/2]

TraCIAPI::POIScope::POIScope ( const POIScope src)
private

invalidated copy constructor

Member Function Documentation

◆ add()

void TraCIAPI::POIScope::add ( const std::string &  poiID,
double  x,
double  y,
const libsumo::TraCIColor c,
const std::string &  type,
int  layer,
const std::string &  imgFile,
double  width,
double  height,
double  angle 
) const

◆ clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )
inherited

Definition at line 3707 of file TraCIAPI.cpp.

◆ getAllContextSubscriptionResults()

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

Definition at line 3691 of file TraCIAPI.cpp.

◆ getAllSubscriptionResults()

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

Definition at line 3675 of file TraCIAPI.cpp.

◆ getAngle()

double TraCIAPI::POIScope::getAngle ( const std::string &  poiID) const

Definition at line 1353 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POI_VARIABLE, and libsumo::VAR_ANGLE.

◆ getColor()

libsumo::TraCIColor TraCIAPI::POIScope::getColor ( const std::string &  poiID) const

Definition at line 1338 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POI_VARIABLE, and libsumo::VAR_COLOR.

Referenced by TraCITestClient::testAPI().

◆ getContextSubscriptionResults()

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

Definition at line 3697 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

◆ getHeight()

double TraCIAPI::POIScope::getHeight ( const std::string &  poiID) const

Definition at line 1348 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POI_VARIABLE, and libsumo::VAR_HEIGHT.

◆ getIDCount()

int TraCIAPI::POIScope::getIDCount ( ) const

Definition at line 1323 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POI_VARIABLE, and libsumo::ID_COUNT.

Referenced by TraCITestClient::testAPI().

◆ getIDList()

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

Definition at line 1318 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POI_VARIABLE, and libsumo::TRACI_ID_LIST.

Referenced by TraCITestClient::testAPI().

◆ getImageFile()

std::string TraCIAPI::POIScope::getImageFile ( const std::string &  poiID) const

Definition at line 1358 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POI_VARIABLE, and libsumo::VAR_IMAGEFILE.

◆ getModifiableContextSubscriptionResults()

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

Definition at line 3720 of file TraCIAPI.cpp.

◆ getModifiableSubscriptionResults()

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

Definition at line 3714 of file TraCIAPI.cpp.

◆ getParameter()

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

retrieve generic paramter

Definition at line 3630 of file TraCIAPI.cpp.

References libsumo::TYPE_STRING, libsumo::VAR_PARAMETER, tcpip::Storage::writeByte(), and tcpip::Storage::writeString().

Referenced by TraCITestClient::testAPI().

◆ getPosition()

libsumo::TraCIPosition TraCIAPI::POIScope::getPosition ( const std::string &  poiID) const

Definition at line 1333 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POI_VARIABLE, and libsumo::VAR_POSITION.

Referenced by TraCITestClient::testAPI().

◆ getSubscriptionResults()

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

Definition at line 3681 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

◆ getType()

std::string TraCIAPI::POIScope::getType ( const std::string &  poiID) const

Definition at line 1328 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POI_VARIABLE, and libsumo::VAR_TYPE.

◆ getWidth()

double TraCIAPI::POIScope::getWidth ( const std::string &  poiID) const

Definition at line 1343 of file TraCIAPI.cpp.

References libsumo::CMD_GET_POI_VARIABLE, and libsumo::VAR_WIDTH.

◆ operator=()

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

invalidated assignment operator

◆ remove()

void TraCIAPI::POIScope::remove ( const std::string &  poiID,
int  layer = 0 
) const

◆ setAngle()

void TraCIAPI::POIScope::setAngle ( const std::string &  poiID,
double  angle 
) const

◆ setColor()

void TraCIAPI::POIScope::setColor ( const std::string &  poiID,
const libsumo::TraCIColor c 
) const

◆ setHeight()

void TraCIAPI::POIScope::setHeight ( const std::string &  poiID,
double  height 
) const

◆ setImageFile()

void TraCIAPI::POIScope::setImageFile ( const std::string &  poiID,
const std::string &  imageFile 
) const

◆ setParameter()

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

◆ setPosition()

void TraCIAPI::POIScope::setPosition ( const std::string &  poiID,
double  x,
double  y 
) const

◆ setType()

void TraCIAPI::POIScope::setType ( const std::string &  poiID,
const std::string &  setType 
) const

◆ setWidth()

void TraCIAPI::POIScope::setWidth ( const std::string &  poiID,
double  width 
) const

◆ subscribe()

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

Definition at line 3653 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

◆ subscribeContext()

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

Definition at line 3665 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Field Documentation

◆ myCmdGetID

int TraCIAPI::TraCIScopeWrapper::myCmdGetID
protectedinherited

Definition at line 145 of file TraCIAPI.h.

◆ myCmdSetID

int TraCIAPI::TraCIScopeWrapper::myCmdSetID
protectedinherited

Definition at line 146 of file TraCIAPI.h.

◆ myContextSubscribeID

int TraCIAPI::TraCIScopeWrapper::myContextSubscribeID
protectedinherited

Definition at line 148 of file TraCIAPI.h.

◆ myContextSubscriptionResults

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

Definition at line 150 of file TraCIAPI.h.

◆ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent
protectedinherited

The parent TraCI client which offers the connection.

Definition at line 144 of file TraCIAPI.h.

Referenced by TraCIAPI::EdgeScope::getIDList().

◆ mySubscribeID

int TraCIAPI::TraCIScopeWrapper::mySubscribeID
protectedinherited

Definition at line 147 of file TraCIAPI.h.

◆ mySubscriptionResults

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

Definition at line 149 of file TraCIAPI.h.


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