SUMO - Simulation of Urban MObility
TraCI Class Reference

C++ TraCI client API implementation. More...

#include <TraCI.h>

Collaboration diagram for TraCI:
Collaboration graph

Public Types

typedef std::map< std::string, SubscribedValuesSubscribedContextValues
 
typedef std::map< std::string, TraCIValuesSubscribedValues
 
typedef std::map< int, TraCIValueTraCIValues
 {object->{variable->value}} More...
 

Public Member Functions

const SubscribedContextValuesgetContextSubscriptionResults () const
 
const SubscribedValuesgetContextSubscriptionResults (const std::string &objID) const
 
const SubscribedValuesgetSubscriptionResults () const
 
const TraCIValuesgetSubscriptionResults (const std::string &objID) const
 
void simulationStep (SUMOTime time=0)
 Advances by one step (or up to the given time) More...
 
Connection handling
void close ()
 Connects to the specified SUMO server. More...
 

Static Public Member Functions

static std::pair< MSLane *, double > convertCartesianToRoadMap (Position pos)
 
static MSEdgegetEdge (const std::string &edgeID)
 
static const MSLanegetLaneChecking (const std::string &edgeID, int laneIndex, double pos)
 
static std::vector< std::string > & getLoadArgs ()
 
static void load (const std::vector< std::string > &args)
 load a simulation with the given arguments More...
 
static Position makePosition (const TraCIPosition &position)
 
static PositionVector makePositionVector (const TraCIPositionVector &vector)
 
static RGBColor makeRGBColor (const TraCIColor &color)
 
static TraCIColor makeTraCIColor (const RGBColor &color)
 
static TraCIPosition makeTraCIPosition (const Position &position)
 
static TraCIPositionVector makeTraCIPositionVector (const PositionVector &positionVector)
 helper functions More...
 

Private Member Functions

TraCIoperator= (const TraCI &src)
 invalidated assignment operator More...
 
 TraCI (const TraCI &src)
 invalidated copy constructor More...
 

Private Attributes

SubscribedContextValues mySubscribedContextValues
 
SubscribedValues mySubscribedValues
 

Static Private Attributes

static std::vector< std::string > myLoadArgs
 

Detailed Description

C++ TraCI client API implementation.

Definition at line 53 of file TraCI.h.

Member Typedef Documentation

◆ SubscribedContextValues

typedef std::map<std::string, SubscribedValues> TraCI::SubscribedContextValues

Definition at line 79 of file TraCI.h.

◆ SubscribedValues

typedef std::map<std::string, TraCIValues> TraCI::SubscribedValues

Definition at line 78 of file TraCI.h.

◆ TraCIValues

typedef std::map<int, TraCIValue> TraCI::TraCIValues

{object->{variable->value}}

Definition at line 77 of file TraCI.h.

Constructor & Destructor Documentation

◆ TraCI()

TraCI::TraCI ( const TraCI src)
private

invalidated copy constructor

Referenced by getLoadArgs().

Member Function Documentation

◆ close()

void TraCI::close ( )

Connects to the specified SUMO server.

Parameters
[in]hostThe name of the host to connect to
[in]portThe port to connect to
Exceptions
tcpip::SocketExceptionif the connection failsends the simulation and closes the connection

Definition at line 66 of file TraCI.cpp.

◆ convertCartesianToRoadMap()

std::pair< MSLane *, double > TraCI::convertCartesianToRoadMap ( Position  pos)
static

◆ getContextSubscriptionResults() [1/2]

const TraCI::SubscribedContextValues & TraCI::getContextSubscriptionResults ( ) const

Definition at line 93 of file TraCI.cpp.

References mySubscribedContextValues.

◆ getContextSubscriptionResults() [2/2]

const TraCI::SubscribedValues & TraCI::getContextSubscriptionResults ( const std::string &  objID) const

Definition at line 98 of file TraCI.cpp.

References mySubscribedContextValues.

◆ getEdge()

MSEdge * TraCI::getEdge ( const std::string &  edgeID)
static

◆ getLaneChecking()

const MSLane * TraCI::getLaneChecking ( const std::string &  edgeID,
int  laneIndex,
double  pos 
)
static

◆ getLoadArgs()

static std::vector<std::string>& TraCI::getLoadArgs ( )
inlinestatic

Definition at line 103 of file TraCI.h.

References myLoadArgs, operator=(), and TraCI().

Referenced by GUIRunThread::makeStep(), MSNet::simulate(), and MSNet::simulationState().

◆ getSubscriptionResults() [1/2]

const TraCI::SubscribedValues & TraCI::getSubscriptionResults ( ) const

Definition at line 79 of file TraCI.cpp.

References mySubscribedValues.

◆ getSubscriptionResults() [2/2]

const TraCI::TraCIValues & TraCI::getSubscriptionResults ( const std::string &  objID) const

Definition at line 84 of file TraCI.cpp.

References mySubscribedValues.

◆ load()

void TraCI::load ( const std::vector< std::string > &  args)
static

load a simulation with the given arguments

Definition at line 61 of file TraCI.cpp.

References myLoadArgs.

Referenced by TraCIServer::dispatchCommand().

◆ makePosition()

Position TraCI::makePosition ( const TraCIPosition position)
static

◆ makePositionVector()

PositionVector TraCI::makePositionVector ( const TraCIPositionVector vector)
static

Definition at line 118 of file TraCI.cpp.

Referenced by TraCI_Polygon::add(), and TraCI_Polygon::setShape().

◆ makeRGBColor()

RGBColor TraCI::makeRGBColor ( const TraCIColor color)
static

◆ makeTraCIColor()

◆ makeTraCIPosition()

TraCIPosition TraCI::makeTraCIPosition ( const Position position)
static

◆ makeTraCIPositionVector()

TraCIPositionVector TraCI::makeTraCIPositionVector ( const PositionVector positionVector)
static

helper functions

Definition at line 108 of file TraCI.cpp.

References makeTraCIPosition().

Referenced by TraCI_Polygon::getShape(), TraCI_Junction::getShape(), and TraCIServerAPI_Polygon::processSet().

◆ operator=()

TraCI& TraCI::operator= ( const TraCI src)
private

invalidated assignment operator

Referenced by getLoadArgs().

◆ simulationStep()

void TraCI::simulationStep ( SUMOTime  time = 0)

Advances by one step (or up to the given time)

Field Documentation

◆ myLoadArgs

std::vector< std::string > TraCI::myLoadArgs
staticprivate

Definition at line 117 of file TraCI.h.

Referenced by getLoadArgs(), and load().

◆ mySubscribedContextValues

SubscribedContextValues TraCI::mySubscribedContextValues
private

Definition at line 115 of file TraCI.h.

Referenced by getContextSubscriptionResults().

◆ mySubscribedValues

SubscribedValues TraCI::mySubscribedValues
private

Definition at line 114 of file TraCI.h.

Referenced by getSubscriptionResults().


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