TraCI Class Reference

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

#include <TraCI.h>

Collaboration diagram for TraCI:

Public Types
typedef std::map< std::string, SubscribedValues >	SubscribedContextValues
typedef std::map< std::string, TraCIValues >	SubscribedValues
typedef std::map< int, TraCIValue >	TraCIValues
	{object->{variable->value}} More...

Public Member Functions
const SubscribedContextValues &	getContextSubscriptionResults () const
const SubscribedValues &	getContextSubscriptionResults (const std::string &objID) const
const SubscribedValues &	getSubscriptionResults () const
const TraCIValues &	getSubscriptionResults (const std::string &objID) const
Connection handling
void	close ()
	Connects to the specified SUMO server. More...

Static Public Member Functions
static std::pair< MSLane *, double >	convertCartesianToRoadMap (Position pos)
static MSEdge *	getEdge (const std::string &edgeID)
static const MSLane *	getLaneChecking (const std::string &edgeID, int laneIndex, double pos)
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...
static void	simulationStep (const SUMOTime time=0)
	Advances by one step (or up to the given time) More...

Private Member Functions
TraCI &	operator= (const TraCI &src)
	invalidated assignment operator More...
	TraCI (const TraCI &src)
	invalidated copy constructor More...

Private Attributes
SubscribedContextValues	mySubscribedContextValues
SubscribedValues	mySubscribedValues

Detailed Description

C++ TraCI client API implementation.

Definition at line 52 of file TraCI.h.

Member Typedef Documentation

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

Definition at line 78 of file TraCI.h.

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

Definition at line 77 of file TraCI.h.

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

{object->{variable->value}}

Definition at line 76 of file TraCI.h.

Constructor & Destructor Documentation

TraCI::TraCI ( const TraCI &  src )

private

invalidated copy constructor

Member Function Documentation

void TraCI::close

(

)

Connects to the specified SUMO server.

Parameters

[in]	host	The name of the host to connect to
[in]	port	The port to connect to

Exceptions

tcpip::SocketException

if the connection failsends the simulation and closes the connection

Definition at line 77 of file TraCI.cpp.

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

static

XXX use rtree instead

Definition at line 196 of file TraCI.cpp.

References MSEdge::dictionary(), MSNet::getEdgeControl(), MSEdgeControl::getEdgeNames(), and MSNet::getInstance().

Referenced by TraCI_Vehicle::getDrivingDistance2D().

const TraCI::SubscribedContextValues & TraCI::getContextSubscriptionResults

(

)

const

Definition at line 104 of file TraCI.cpp.

References mySubscribedContextValues.

const TraCI::SubscribedValues & TraCI::getContextSubscriptionResults

(

const std::string &

objID

)

const

Definition at line 109 of file TraCI.cpp.

References mySubscribedContextValues.

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

static

Definition at line 171 of file TraCI.cpp.

References MSEdge::dictionary().

Referenced by TraCI_Vehicle::getAdaptedTraveltime(), TraCI_Vehicle::getDrivingDistance(), and TraCI_Vehicle::getEffort().

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

static

Definition at line 180 of file TraCI.cpp.

References MSEdge::dictionary(), MSEdge::getLanes(), and MSLane::getLength().

Referenced by TraCIServerAPI_Simulation::commandDistanceRequest(), and TraCIServerAPI_Simulation::commandPositionConversion().

const TraCI::SubscribedValues & TraCI::getSubscriptionResults

(

)

const

Definition at line 90 of file TraCI.cpp.

References mySubscribedValues.

const TraCI::TraCIValues & TraCI::getSubscriptionResults

(

const std::string &

objID

)

const

Definition at line 95 of file TraCI.cpp.

References mySubscribedValues.

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

static

load a simulation with the given arguments

Definition at line 57 of file TraCI.cpp.

References XMLSubSys::init(), NLBuilder::init(), and OptionsIO::setArgs().

Position TraCI::makePosition ( const TraCIPosition &  position )

static

Definition at line 164 of file TraCI.cpp.

References Position::set(), TraCIPosition::x, TraCIPosition::y, and TraCIPosition::z.

Referenced by TraCI_POI::add(), and TraCI_POI::setPosition().

PositionVector TraCI::makePositionVector ( const TraCIPositionVector &  vector )

static

Definition at line 129 of file TraCI.cpp.

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

RGBColor TraCI::makeRGBColor ( const TraCIColor &  color )

static

Definition at line 149 of file TraCI.cpp.

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

Referenced by TraCI_Polygon::add(), TraCI_POI::add(), TraCI_Polygon::setColor(), TraCI_POI::setColor(), and TraCI_VehicleType::setColor().

TraCIColor TraCI::makeTraCIColor ( const RGBColor &  color )

static

Definition at line 139 of file TraCI.cpp.

References TraCIColor::a, RGBColor::alpha(), TraCIColor::b, RGBColor::blue(), TraCIColor::g, RGBColor::green(), TraCIColor::r, and RGBColor::red().

Referenced by TraCI_VehicleType::getColor(), TraCI_Polygon::getColor(), TraCI_POI::getColor(), and TraCI_Vehicle::getColor().

TraCIPosition TraCI::makeTraCIPosition ( const Position &  position )

static

Definition at line 155 of file TraCI.cpp.

References Position::x(), TraCIPosition::x, Position::y(), TraCIPosition::y, TraCIPosition::z, and Position::z().

Referenced by TraCI_Junction::getPosition(), TraCI_Vehicle::getPosition(), and makeTraCIPositionVector().

TraCIPositionVector TraCI::makeTraCIPositionVector ( const PositionVector &  positionVector )

static

helper functions

Definition at line 119 of file TraCI.cpp.

References makeTraCIPosition().

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

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

private

invalidated assignment operator

void TraCI::simulationStep ( const SUMOTime  time = 0 )

static

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

Definition at line 65 of file TraCI.cpp.

References MSNet::getInstance(), and MSNet::simulationStep().

Field Documentation

SubscribedContextValues TraCI::mySubscribedContextValues

private

Definition at line 110 of file TraCI.h.

Referenced by getContextSubscriptionResults().

SubscribedValues TraCI::mySubscribedValues

private

Definition at line 109 of file TraCI.h.

Referenced by getSubscriptionResults().

---

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

• TraCI.h
• TraCI.cpp