Eclipse SUMO - Simulation of Urban MObility
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes
TraCIAPI::PolygonScope Class Reference

Scope for interaction with polygons. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::PolygonScope:
[legend]
Collaboration diagram for TraCIAPI::PolygonScope:
[legend]

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
 
bool getFilled (const std::string &polygonID) const
 
int getIDCount () const
 
std::vector< std::string > getIDList () const
 
double getLineWidth (const std::string &polygonID) const
 
libsumo::SubscriptionResults & getModifiableContextSubscriptionResults (const std::string &objID)
 
libsumo::SubscriptionResults & getModifiableSubscriptionResults ()
 
std::string getParameter (const std::string &objectID, const std::string &key) const
 retrieve generic parameter More...
 
std::pair< std::string, std::string > getParameterWithKey (const std::string &objectID, const std::string &key) const
 retrieve generic parameter and return (key, value) tuple 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 Member Functions

int getByte (int var, const std::string &id, tcpip::Storage *add=0) const
 
libsumo::TraCIColor getCol (int var, const std::string &id, tcpip::Storage *add=0) const
 
double getDouble (int var, const std::string &id, tcpip::Storage *add=0) const
 
std::vector< double > getDoubleVector (int var, const std::string &id, tcpip::Storage *add=0) const
 
int getInt (int var, const std::string &id, tcpip::Storage *add=0) const
 
libsumo::TraCIPositionVector getPolygon (int var, const std::string &id, tcpip::Storage *add=0) const
 
libsumo::TraCIPosition getPos (int var, const std::string &id, tcpip::Storage *add=0) const
 
libsumo::TraCIPosition getPos3D (int var, const std::string &id, tcpip::Storage *add=0) const
 
std::string getString (int var, const std::string &id, tcpip::Storage *add=0) const
 
std::vector< std::string > getStringVector (int var, const std::string &id, tcpip::Storage *add=0) const
 
libsumo::TraCIStage getTraCIStage (int var, const std::string &id, tcpip::Storage *add=0) const
 
int getUnsignedByte (int var, const std::string &id, tcpip::Storage *add=0) const
 
void setDouble (int var, const std::string &id, double value) const
 
void setInt (int var, const std::string &id, int value) const
 
void setString (int var, const std::string &id, const std::string &value) const
 
void setStringVector (int var, const std::string &id, const std::vector< std::string > &value) const
 

Protected Attributes

TraCIAPI & myParent
 The parent TraCI client which offers the connection. More...
 

Private Attributes

int myCmdGetID
 
int myCmdSetID
 
int myContextSubscribeID
 
libsumo::ContextSubscriptionResults myContextSubscriptionResults
 
int mySubscribeID
 
libsumo::SubscriptionResults mySubscriptionResults
 

Detailed Description

Scope for interaction with polygons.

Definition at line 363 of file TraCIAPI.h.

Constructor & Destructor Documentation

◆ PolygonScope()

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

Definition at line 365 of file TraCIAPI.h.

◆ ~PolygonScope()

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

Definition at line 366 of file TraCIAPI.h.

Member Function Documentation

◆ add()

void TraCIAPI::PolygonScope::add ( const std::string &  polygonID,
const libsumo::TraCIPositionVector &  shape,
const libsumo::TraCIColor &  c,
bool  fill,
const std::string &  type,
int  layer 
) const

Definition at line 1292 of file TraCIAPI.cpp.

References libsumo::TraCIColor::a, libsumo::ADD, libsumo::TraCIColor::b, libsumo::CMD_SET_POLYGON_VARIABLE, libsumo::TraCIColor::g, libsumo::TraCIColor::r, libsumo::TYPE_COLOR, libsumo::TYPE_COMPOUND, libsumo::TYPE_INTEGER, libsumo::TYPE_POLYGON, libsumo::TYPE_STRING, libsumo::TYPE_UBYTE, libsumo::TraCIPositionVector::value, tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

◆ clearSubscriptionResults()

void TraCIAPI::TraCIScopeWrapper::clearSubscriptionResults ( )
inherited

Definition at line 3894 of file TraCIAPI.cpp.

◆ getAllContextSubscriptionResults()

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

Definition at line 3878 of file TraCIAPI.cpp.

◆ getAllSubscriptionResults()

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

Definition at line 3862 of file TraCIAPI.cpp.

◆ getByte()

int TraCIAPI::TraCIScopeWrapper::getByte ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3564 of file TraCIAPI.cpp.

References libsumo::INVALID_INT_VALUE, and libsumo::TYPE_BYTE.

◆ getCol()

libsumo::TraCIColor TraCIAPI::TraCIScopeWrapper::getCol ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3680 of file TraCIAPI.cpp.

References libsumo::TraCIColor::a, libsumo::TraCIColor::b, libsumo::TraCIColor::g, libsumo::TraCIColor::r, and libsumo::TYPE_COLOR.

◆ getColor()

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

Definition at line 1237 of file TraCIAPI.cpp.

References libsumo::VAR_COLOR.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getContextSubscriptionResults()

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

Definition at line 3884 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getDouble()

double TraCIAPI::TraCIScopeWrapper::getDouble ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3585 of file TraCIAPI.cpp.

References libsumo::INVALID_DOUBLE_VALUE, and libsumo::TYPE_DOUBLE.

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

Here is the caller graph for this function:

◆ getDoubleVector()

std::vector< double > TraCIAPI::TraCIScopeWrapper::getDoubleVector ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3666 of file TraCIAPI.cpp.

References libsumo::TYPE_DOUBLELIST.

◆ getFilled()

bool TraCIAPI::PolygonScope::getFilled ( const std::string &  polygonID) const

Definition at line 1222 of file TraCIAPI.cpp.

References libsumo::VAR_FILL.

◆ getIDCount()

int TraCIAPI::TraCIScopeWrapper::getIDCount ( ) const
inherited

Definition at line 3749 of file TraCIAPI.cpp.

References libsumo::ID_COUNT.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getIDList()

std::vector< std::string > TraCIAPI::TraCIScopeWrapper::getIDList ( ) const
inherited

Definition at line 3743 of file TraCIAPI.cpp.

References libsumo::TRACI_ID_LIST.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getInt()

int TraCIAPI::TraCIScopeWrapper::getInt ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3575 of file TraCIAPI.cpp.

References libsumo::INVALID_INT_VALUE, and libsumo::TYPE_INTEGER.

◆ getLineWidth()

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

Definition at line 1217 of file TraCIAPI.cpp.

References libsumo::VAR_WIDTH.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getModifiableContextSubscriptionResults()

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

Definition at line 3907 of file TraCIAPI.cpp.

◆ getModifiableSubscriptionResults()

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

Definition at line 3901 of file TraCIAPI.cpp.

◆ getParameter()

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

retrieve generic parameter

Definition at line 3755 of file TraCIAPI.cpp.

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

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getParameterWithKey()

std::pair< std::string, std::string > TraCIAPI::TraCIScopeWrapper::getParameterWithKey ( const std::string &  objectID,
const std::string &  key 
) const
inherited

retrieve generic parameter and return (key, value) tuple

Definition at line 3764 of file TraCIAPI.cpp.

References libsumo::TYPE_COMPOUND, libsumo::TYPE_STRING, libsumo::VAR_PARAMETER_WITH_KEY, tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getPolygon()

libsumo::TraCIPositionVector TraCIAPI::TraCIScopeWrapper::getPolygon ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3595 of file TraCIAPI.cpp.

References libsumo::TYPE_POLYGON, libsumo::TraCIPositionVector::value, libsumo::TraCIPosition::x, libsumo::TraCIPosition::y, and libsumo::TraCIPosition::z.

◆ getPos()

libsumo::TraCIPosition TraCIAPI::TraCIScopeWrapper::getPos ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3616 of file TraCIAPI.cpp.

References libsumo::POSITION_2D, libsumo::TraCIPosition::x, libsumo::TraCIPosition::y, and libsumo::TraCIPosition::z.

◆ getPos3D()

libsumo::TraCIPosition TraCIAPI::TraCIScopeWrapper::getPos3D ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3629 of file TraCIAPI.cpp.

References libsumo::POSITION_3D, libsumo::TraCIPosition::x, libsumo::TraCIPosition::y, and libsumo::TraCIPosition::z.

◆ getShape()

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

Definition at line 1232 of file TraCIAPI.cpp.

References libsumo::VAR_SHAPE.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getString()

std::string TraCIAPI::TraCIScopeWrapper::getString ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3642 of file TraCIAPI.cpp.

References libsumo::TYPE_STRING.

◆ getStringVector()

std::vector< std::string > TraCIAPI::TraCIScopeWrapper::getStringVector ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3652 of file TraCIAPI.cpp.

References libsumo::TYPE_STRINGLIST.

◆ getSubscriptionResults()

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

Definition at line 3868 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ getTraCIStage()

libsumo::TraCIStage TraCIAPI::TraCIScopeWrapper::getTraCIStage ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3694 of file TraCIAPI.cpp.

References libsumo::TraCIStage::arrivalPos, libsumo::TraCIStage::cost, libsumo::TraCIStage::depart, libsumo::TraCIStage::departPos, libsumo::TraCIStage::description, libsumo::TraCIStage::destStop, libsumo::TraCIStage::edges, libsumo::TraCIStage::intended, libsumo::TraCIStage::length, libsumo::TraCIStage::line, libsumo::TraCIStage::travelTime, libsumo::TraCIStage::type, libsumo::TYPE_COMPOUND, and libsumo::TraCIStage::vType.

◆ getType()

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

Definition at line 1227 of file TraCIAPI.cpp.

References libsumo::VAR_TYPE.

◆ getUnsignedByte()

int TraCIAPI::TraCIScopeWrapper::getUnsignedByte ( int  var,
const std::string &  id,
tcpip::Storage *  add = 0 
) const
protectedinherited

Definition at line 3554 of file TraCIAPI.cpp.

References libsumo::INVALID_INT_VALUE, and libsumo::TYPE_UBYTE.

◆ remove()

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

Definition at line 1319 of file TraCIAPI.cpp.

References libsumo::CMD_SET_POLYGON_VARIABLE, libsumo::REMOVE, libsumo::TYPE_INTEGER, tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

◆ setColor()

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

Definition at line 1280 of file TraCIAPI.cpp.

References libsumo::TraCIColor::a, libsumo::TraCIColor::b, libsumo::CMD_SET_POLYGON_VARIABLE, libsumo::TraCIColor::g, libsumo::TraCIColor::r, libsumo::TYPE_COLOR, libsumo::VAR_COLOR, and tcpip::Storage::writeUnsignedByte().

◆ setDouble()

void TraCIAPI::TraCIScopeWrapper::setDouble ( int  var,
const std::string &  id,
double  value 
) const
protectedinherited

Definition at line 3807 of file TraCIAPI.cpp.

References libsumo::TYPE_DOUBLE, tcpip::Storage::writeDouble(), and tcpip::Storage::writeUnsignedByte().

◆ setInt()

void TraCIAPI::TraCIScopeWrapper::setInt ( int  var,
const std::string &  id,
int  value 
) const
protectedinherited

Definition at line 3797 of file TraCIAPI.cpp.

References libsumo::TYPE_INTEGER, tcpip::Storage::writeInt(), and tcpip::Storage::writeUnsignedByte().

◆ setLineWidth()

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

Definition at line 1242 of file TraCIAPI.cpp.

References libsumo::CMD_SET_POLYGON_VARIABLE, libsumo::TYPE_DOUBLE, libsumo::VAR_WIDTH, tcpip::Storage::writeDouble(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setParameter()

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

set generic paramter

Definition at line 3783 of file TraCIAPI.cpp.

References libsumo::TYPE_COMPOUND, libsumo::TYPE_STRING, libsumo::VAR_PARAMETER, tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setShape()

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

Definition at line 1261 of file TraCIAPI.cpp.

References libsumo::CMD_SET_POLYGON_VARIABLE, libsumo::TYPE_POLYGON, libsumo::TraCIPositionVector::value, libsumo::VAR_SHAPE, tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), tcpip::Storage::writeUnsignedByte(), libsumo::TraCIPosition::x, and libsumo::TraCIPosition::y.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ setString()

void TraCIAPI::TraCIScopeWrapper::setString ( int  var,
const std::string &  id,
const std::string &  value 
) const
protectedinherited

Definition at line 3817 of file TraCIAPI.cpp.

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

◆ setStringVector()

void TraCIAPI::TraCIScopeWrapper::setStringVector ( int  var,
const std::string &  id,
const std::vector< std::string > &  value 
) const
protectedinherited

Definition at line 3827 of file TraCIAPI.cpp.

References libsumo::TYPE_STRINGLIST, tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

◆ setType()

void TraCIAPI::PolygonScope::setType ( const std::string &  polygonID,
const std::string &  setType 
) const

Definition at line 1251 of file TraCIAPI.cpp.

References libsumo::CMD_SET_POLYGON_VARIABLE, libsumo::TYPE_STRING, libsumo::VAR_TYPE, tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

◆ subscribe()

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

Definition at line 3840 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

◆ 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 3852 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Here is the caller graph for this function:

Field Documentation

◆ myCmdGetID

int TraCIAPI::TraCIScopeWrapper::myCmdGetID
privateinherited

Definition at line 154 of file TraCIAPI.h.

◆ myCmdSetID

int TraCIAPI::TraCIScopeWrapper::myCmdSetID
privateinherited

Definition at line 155 of file TraCIAPI.h.

◆ myContextSubscribeID

int TraCIAPI::TraCIScopeWrapper::myContextSubscribeID
privateinherited

Definition at line 157 of file TraCIAPI.h.

◆ myContextSubscriptionResults

libsumo::ContextSubscriptionResults TraCIAPI::TraCIScopeWrapper::myContextSubscriptionResults
privateinherited

Definition at line 159 of file TraCIAPI.h.

◆ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent
protectedinherited

The parent TraCI client which offers the connection.

Definition at line 151 of file TraCIAPI.h.

◆ mySubscribeID

int TraCIAPI::TraCIScopeWrapper::mySubscribeID
privateinherited

Definition at line 156 of file TraCIAPI.h.

◆ mySubscriptionResults

libsumo::SubscriptionResults TraCIAPI::TraCIScopeWrapper::mySubscriptionResults
privateinherited

Definition at line 158 of file TraCIAPI.h.

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