TraCI server used to control sumo by a remote TraCI client. More...

#include <TraCIServer.h>

Inheritance diagram for TraCIServer:

Collaboration diagram for TraCIServer:

Data Structures
struct	SocketInfo

Public Types
typedef bool(*	CmdExecutor) (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)
	Definition of a method to be called for serving an associated commandID. More...

typedef bool(*	SubscriptionHandler) (const std::string &objID, const int variable, VariableWrapper wrapper, tcpip::Storage paramData)
	Definition of a method to be called for serving an associated commandID. More...

Public Member Functions
void	cleanup ()
	clean up subscriptions More...

virtual void	clear ()

virtual void	empty (const std::string &)

std::vector< std::string > &	getLoadArgs ()

SUMOTime	getTargetTime () const

const std::map< MSNet::TransportableState, std::vector< std::string > > &	getTransportableStateChanges () const

const std::map< MSNet::VehicleState, std::vector< std::string > > &	getVehicleStateChanges () const

int	processCommands (const SUMOTime step, const bool afterMove=false)
	process all commands until the next SUMO simulation step. It is guaranteed that t->getTargetTime() >= myStep after call (except the case that a load or close command is received)s More...

virtual void	setContext (const std::string *const)

void	stateLoaded (SUMOTime targetTime)
	updates myTargetTime and resets vehicle state changes after loading a simulation state More...

void	transportableStateChanged (const MSTransportable *const transportable, MSNet::TransportableState to, const std::string &info="")
	Called if a transportable changes its state. More...

void	vehicleStateChanged (const SUMOVehicle *const vehicle, MSNet::VehicleState to, const std::string &info="")
	Called if a vehicle changes its state. More...

void	writePositionVector (tcpip::Storage &outputStorage, const libsumo::TraCIPositionVector &shape)

void	writeResponseWithLength (tcpip::Storage &outputStorage, tcpip::Storage &tempMsg)

Writing Status Messages
void	writeStatusCmd (int commandId, int status, const std::string &description, tcpip::Storage &outputStorage)
	Writes a status command to the given storage. More...

void	writeStatusCmd (int commandId, int status, const std::string &description)
	Writes a status command to myOutputStorage. More...

bool	writeErrorStatusCmd (int commandId, const std::string &description, tcpip::Storage &outputStorage)
	Writes a status command to the given storage with status = RTYPE_ERR. More...

Helpers for reading and checking values
bool	readTypeCheckingInt (tcpip::Storage &inputStorage, int &into)
	Reads the value type and an int, verifying the type. More...

bool	readTypeCheckingDouble (tcpip::Storage &inputStorage, double &into)
	Reads the value type and a double, verifying the type. More...

bool	readTypeCheckingString (tcpip::Storage &inputStorage, std::string &into)
	Reads the value type and a string, verifying the type. More...

bool	readTypeCheckingStringList (tcpip::Storage &inputStorage, std::vector< std::string > &into)
	Reads the value type and a string list, verifying the type. More...

bool	readTypeCheckingDoubleList (tcpip::Storage &inputStorage, std::vector< double > &into)
	Reads the value type and a double list, verifying the type. More...

bool	readTypeCheckingColor (tcpip::Storage &inputStorage, libsumo::TraCIColor &into)
	Reads the value type and a color, verifying the type. More...

bool	readTypeCheckingPosition2D (tcpip::Storage &inputStorage, libsumo::TraCIPosition &into)
	Reads the value type and a 2D position, verifying the type. More...

bool	readTypeCheckingByte (tcpip::Storage &inputStorage, int &into)
	Reads the value type and a byte, verifying the type. More...

bool	readTypeCheckingUnsignedByte (tcpip::Storage &inputStorage, int &into)
	Reads the value type and an unsigned byte, verifying the type. More...

bool	readTypeCheckingPolygon (tcpip::Storage &inputStorage, PositionVector &into)
	Reads the value type and a polygon, verifying the type. More...

VariableWrapper interface
void	initWrapper (const int domainID, const int variable, const std::string &objID)

bool	wrapDouble (const std::string &objID, const int variable, const double value)

bool	wrapInt (const std::string &objID, const int variable, const int value)

bool	wrapString (const std::string &objID, const int variable, const std::string &value)

bool	wrapStringList (const std::string &objID, const int variable, const std::vector< std::string > &value)

bool	wrapDoubleList (const std::string &objID, const int variable, const std::vector< double > &value)

bool	wrapPosition (const std::string &objID, const int variable, const libsumo::TraCIPosition &value)

bool	wrapPositionVector (const std::string &objID, const int variable, const libsumo::TraCIPositionVector &value)

bool	wrapColor (const std::string &objID, const int variable, const libsumo::TraCIColor &value)

bool	wrapStringDoublePair (const std::string &objID, const int variable, const std::pair< std::string, double > &value)

bool	wrapStringPair (const std::string &objID, const int variable, const std::pair< std::string, std::string > &value)

tcpip::Storage &	getWrapperStorage ()

Static Public Member Functions
static TraCIServer *	getInstance ()

Initialisation and Shutdown
static void	openSocket (const std::map< int, CmdExecutor > &execs)
	Initialises the server. More...

static void	close ()
	request termination of connection More...

static bool	wasClosed ()
	check whether close was requested More...

Data Fields
SubscriptionHandler	handle

Private Member Functions
bool	addObjectVariableSubscription (const int commandId, const bool hasContext)

bool	addSubscriptionFilter ()

void	addSubscriptionFilterDownstreamDistance (double dist)

void	addSubscriptionFilterFieldOfVision (double openingAngle)
	Filter only vehicles within field of vision. More...

void	addSubscriptionFilterLanes (std::vector< int > lanes)

void	addSubscriptionFilterLateralDistance (double dist)
	Filter only vehicles within the given lateral distance. More...

void	addSubscriptionFilterLeadFollow ()

void	addSubscriptionFilterNoOpposite ()

void	addSubscriptionFilterTurn (double dist)

void	addSubscriptionFilterUpstreamDistance (double dist)

void	addSubscriptionFilterVClass (SVCPermissions vClasses)

void	addSubscriptionFilterVType (std::set< std::string > vTypes)

bool	centralObject (const libsumo::Subscription &s, const std::string &objID)
	check whether a found objID refers to the central object of a context subscription More...

void	checkClientOrdering ()
	Called once after connection of all clients for executing SET_ORDER (and possibly prior GET_VERSION) commands, that should be executed before simulation starts (in processCommandsUntilNextSimStep()). More...

int	dispatchCommand ()
	Handles command, writes response to myOutputStorage. More...

void	initialiseSubscription (libsumo::Subscription &s)

SUMOTime	nextTargetTime () const
	get the minimal next target time among all clients More...

TraCIServer &	operator= (const TraCIServer &s)=delete
	Invalidated assignment operator. More...

void	processReorderingRequests ()
	checks for and processes reordering requests (relevant for multiple clients) More...

bool	processSingleSubscription (const libsumo::Subscription &s, tcpip::Storage &writeInto, std::string &errors)

int	readCommandID (int &commandStart, int &commandLength)
	Reads the next command ID from the input storage. More...

std::map< int, SocketInfo * >::iterator	removeCurrentSocket ()
	removes myCurrentSocket from mySockets and returns an iterator pointing to the next member according to the ordering More...

void	removeFilters ()

void	removeSubscription (int commandId, const std::string &identity, int domain)

void	sendOutputToAll () const
	send out subscription results (actually just the content of myOutputStorage) to clients which will act in this step (i.e. with client target time <= myTargetTime) More...

void	sendSingleSimStepResponse ()
	sends an empty response to a simstep command to the current client. (This applies to a situation where the TraCI step frequency is higher than the SUMO step frequency) More...

	TraCIServer (const SUMOTime begin, const int port, const int numClients)
	Constructor. More...

virtual	~TraCIServer ()
	Destructor. More...

Server-internal command handling
bool	commandGetVersion ()
	Returns the TraCI-version. More...

void	postProcessSimulationStep ()
	Handles subscriptions to send after a simstep2 command. More...

Private Attributes
std::map< int, SocketInfo * >::iterator	myCurrentSocket
	The currently active client socket. More...

std::map< int, CmdExecutor >	myExecutors
	Map of commandIds -> their executors; applicable if the executor applies to the method footprint. More...

tcpip::Storage	myInputStorage
	The storage to read from. More...

libsumo::Subscription *	myLastContextSubscription
	The last modified context subscription (the one to add a filter to, see @addSubscriptionFilter(), currently only for vehicle to vehicle context) More...

std::vector< std::string >	myLoadArgs

tcpip::Storage	myOutputStorage
	The storage to write to. More...

std::set< std::pair< int, int > >	myParameterized
	Set of variables which have parameters. More...

std::map< int, SocketInfo * >	mySocketReorderRequests
	This stores the setOrder(int) requests of the clients. More...

std::map< int, SocketInfo * >	mySockets
	The socket connections to the clients the first component (index) determines the client's order (lowest index's commands are processed first),. More...

tcpip::Storage	mySubscriptionCache
	The last timestep's subscription results. More...

std::vector< libsumo::Subscription >	mySubscriptions
	The list of known, still valid subscriptions. More...

SUMOTime	myTargetTime
	The time step to reach until processing the next commands. More...

std::map< MSNet::TransportableState, std::vector< std::string > >	myTransportableStateChanges
	Changes in the states of simulated transportables. More...

std::map< MSNet::VehicleState, std::vector< std::string > >	myVehicleStateChanges
	Changes in the states of simulated vehicles. More...

tcpip::Storage	myWrapperStorage
	A temporary storage to let the wrapper write to. More...

Static Private Attributes
static bool	myDoCloseConnection = false
	Whether the connection was set to be to close. More...

static TraCIServer *	myInstance = nullptr
	Singleton instance of the server. More...

Detailed Description

TraCI server used to control sumo by a remote TraCI client.

Definition at line 59 of file TraCIServer.h.

Member Typedef Documentation

◆ CmdExecutor

typedef bool(* TraCIServer::CmdExecutor) (TraCIServer &server, tcpip::Storage &inputStorage, tcpip::Storage &outputStorage)

Definition of a method to be called for serving an associated commandID.

Definition at line 62 of file TraCIServer.h.

◆ SubscriptionHandler

typedef bool(* libsumo::VariableWrapper::SubscriptionHandler) (const std::string &objID, const int variable, VariableWrapper *wrapper, tcpip::Storage *paramData)

inherited

Definition of a method to be called for serving an associated commandID.

Definition at line 153 of file Subscription.h.

Constructor & Destructor Documentation

◆ TraCIServer()

TraCIServer::TraCIServer	(	const SUMOTime	begin,
		const int	port,
		const int	numClients
	)

private

Constructor.

Parameters

[in] port The port to listen to (to open)

Definition at line 232 of file TraCIServer.cpp.

Referenced by openSocket().

Here is the caller graph for this function:

◆ ~TraCIServer()

TraCIServer::~TraCIServer ( )

privatevirtual

Destructor.

Definition at line 362 of file TraCIServer.cpp.

References mySockets.

Member Function Documentation

◆ addObjectVariableSubscription()

bool TraCIServer::addObjectVariableSubscription	(	const int	commandId,
		const bool	hasContext
	)

private

Definition at line 1244 of file TraCIServer.cpp.

References libsumo::CMD_SUBSCRIBE_SIM_CONTEXT, initialiseSubscription(), libsumo::INVALID_DOUBLE_VALUE, myInputStorage, myParameterized, tcpip::Storage::readDouble(), tcpip::Storage::readString(), tcpip::Storage::readUnsignedByte(), removeSubscription(), STEPS2TIME, SUMOTime_MAX, TIME2STEPS, libsumo::TYPE_DOUBLE, and libsumo::TYPE_STRING.

Referenced by dispatchCommand().

Here is the caller graph for this function:

◆ addSubscriptionFilter()

bool TraCIServer::addSubscriptionFilter ( )

private

Definition at line 1288 of file TraCIServer.cpp.

Referenced by dispatchCommand().

Here is the caller graph for this function:

◆ addSubscriptionFilterDownstreamDistance()

void TraCIServer::addSubscriptionFilterDownstreamDistance ( double dist )

private

Definition at line 1409 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterDownstreamDist, myLastContextSubscription, libsumo::SUBS_FILTER_DOWNSTREAM_DIST, and toString().

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ addSubscriptionFilterFieldOfVision()

void TraCIServer::addSubscriptionFilterFieldOfVision ( double openingAngle )

private

Filter only vehicles within field of vision.

Parameters

[in] openingAngle The opening angle of the circle sector

Definition at line 1462 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterFieldOfVisionOpeningAngle, myLastContextSubscription, libsumo::SUBS_FILTER_FIELD_OF_VISION, and toString().

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ addSubscriptionFilterLanes()

void TraCIServer::addSubscriptionFilterLanes ( std::vector< int > lanes )

private

Definition at line 1392 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterLanes, myLastContextSubscription, libsumo::SUBS_FILTER_LANES, and toString().

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ addSubscriptionFilterLateralDistance()

void TraCIServer::addSubscriptionFilterLateralDistance ( double dist )

private

Filter only vehicles within the given lateral distance.

Parameters

[in] dist The lateral distance

Definition at line 1471 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterLateralDist, myLastContextSubscription, libsumo::SUBS_FILTER_LATERAL_DIST, and toString().

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ addSubscriptionFilterLeadFollow()

void TraCIServer::addSubscriptionFilterLeadFollow ( )

private

Definition at line 1427 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, myLastContextSubscription, and libsumo::SUBS_FILTER_LEAD_FOLLOW.

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ addSubscriptionFilterNoOpposite()

void TraCIServer::addSubscriptionFilterNoOpposite ( )

private

Definition at line 1401 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, myLastContextSubscription, and libsumo::SUBS_FILTER_NOOPPOSITE.

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ addSubscriptionFilterTurn()

void TraCIServer::addSubscriptionFilterTurn ( double dist )

private

Definition at line 1435 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterFoeDistToJunction, myLastContextSubscription, and libsumo::SUBS_FILTER_TURN.

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ addSubscriptionFilterUpstreamDistance()

void TraCIServer::addSubscriptionFilterUpstreamDistance ( double dist )

private

Definition at line 1418 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterUpstreamDist, myLastContextSubscription, libsumo::SUBS_FILTER_UPSTREAM_DIST, and toString().

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ addSubscriptionFilterVClass()

void TraCIServer::addSubscriptionFilterVClass ( SVCPermissions vClasses )

private

Definition at line 1444 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterVClasses, myLastContextSubscription, libsumo::SUBS_FILTER_VCLASS, and toString().

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ addSubscriptionFilterVType()

void TraCIServer::addSubscriptionFilterVType ( std::set< std::string > vTypes )

private

Definition at line 1453 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Subscription::filterVTypes, myLastContextSubscription, libsumo::SUBS_FILTER_VTYPE, and toString().

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ centralObject()

bool TraCIServer::centralObject	(	const libsumo::Subscription &	s,
		const std::string &	objID
	)

private

check whether a found objID refers to the central object of a context subscription

Definition at line 1644 of file TraCIServer.cpp.

References libsumo::Subscription::commandId, libsumo::Subscription::contextDomain, and libsumo::Subscription::id.

◆ checkClientOrdering()

void TraCIServer::checkClientOrdering ( )

private

Called once after connection of all clients for executing SET_ORDER (and possibly prior GET_VERSION) commands, that should be executed before simulation starts (in processCommandsUntilNextSimStep()).

Definition at line 433 of file TraCIServer.cpp.

References libsumo::CMD_GETVERSION, libsumo::CMD_SETORDER, dispatchCommand(), myCurrentSocket, myInputStorage, myOutputStorage, mySockets, readCommandID(), tcpip::Storage::reset(), TL, tcpip::Storage::writeStorage(), and tcpip::Storage::writeUnsignedByte().

Referenced by TraCIServer().

Here is the caller graph for this function:

◆ cleanup()

void TraCIServer::cleanup ( )

clean up subscriptions

Definition at line 703 of file TraCIServer.cpp.

References OptionsCont::getOptions(), myCurrentSocket, myInputStorage, myOutputStorage, mySockets, mySubscriptionCache, mySubscriptions, myTargetTime, myTransportableStateChanges, myVehicleStateChanges, tcpip::Storage::reset(), and string2time().

Referenced by MSNet::clearAll().

Here is the caller graph for this function:

◆ clear()

virtual void libsumo::VariableWrapper::clear ( )

inlinevirtualinherited

Reimplemented in libsumo::Helper::SubscriptionWrapper.

Definition at line 158 of file Subscription.h.

◆ close()

void TraCIServer::close ( )

static

request termination of connection

Definition at line 391 of file TraCIServer.cpp.

References myDoCloseConnection, and myInstance.

Referenced by main().

Here is the caller graph for this function:

◆ commandGetVersion()

bool TraCIServer::commandGetVersion ( )

private

Returns the TraCI-version.

Returns: Always true

Definition at line 941 of file TraCIServer.cpp.

References libsumo::CMD_GETVERSION, myOutputStorage, libsumo::RTYPE_OK, tcpip::Storage::size(), libsumo::TRACI_VERSION, tcpip::Storage::writeInt(), writeStatusCmd(), tcpip::Storage::writeStorage(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Referenced by dispatchCommand().

Here is the caller graph for this function:

◆ dispatchCommand()

int TraCIServer::dispatchCommand ( )

private

Handles command, writes response to myOutputStorage.

Definition at line 754 of file TraCIServer.cpp.

Referenced by checkClientOrdering(), and processCommands().

Here is the caller graph for this function:

◆ empty()

virtual void libsumo::VariableWrapper::empty ( const std::string & )

inlinevirtualinherited

Reimplemented in libsumo::Helper::SubscriptionWrapper.

Definition at line 169 of file Subscription.h.

Referenced by libsumo::Helper::handleSingleSubscription().

Here is the caller graph for this function:

◆ getInstance()

static TraCIServer* TraCIServer::getInstance ( void )

inlinestatic

Definition at line 68 of file TraCIServer.h.

References myInstance.

Referenced by MSNet::adaptToState(), NLBuilder::build(), MSNet::clearAll(), GUIApplicationWindow::dependentBuild(), MSNet::generateStatistics(), GUIApplicationWindow::onCmdReload(), GUIApplicationWindow::onUpdReload(), GUIApplicationWindow::onUpdTraCIStatus(), MSNet::postSimStepOutput(), TraCIServerAPI_Simulation::processSet(), MSNet::simulationState(), and MSNet::simulationStep().

Here is the caller graph for this function:

◆ getLoadArgs()

std::vector<std::string>& TraCIServer::getLoadArgs ( )

inline

Definition at line 258 of file TraCIServer.h.

References myLoadArgs.

Referenced by MSNet::adaptToState(), and MSNet::simulationStep().

Here is the caller graph for this function:

◆ getTargetTime()

SUMOTime TraCIServer::getTargetTime ( ) const

inline

Definition at line 64 of file TraCIServer.h.

References myTargetTime.

Referenced by MSNet::simulationStep().

Here is the caller graph for this function:

◆ getTransportableStateChanges()

const std::map<MSNet::TransportableState, std::vector<std::string> >& TraCIServer::getTransportableStateChanges ( ) const

inline

Definition at line 145 of file TraCIServer.h.

References myCurrentSocket, mySockets, and myTransportableStateChanges.

Referenced by TraCIServerAPI_Simulation::writeTransportableStateIDs(), and TraCIServerAPI_Simulation::writeTransportableStateNumber().

Here is the caller graph for this function:

◆ getVehicleStateChanges()

const std::map<MSNet::VehicleState, std::vector<std::string> >& TraCIServer::getVehicleStateChanges ( ) const

inline

Definition at line 135 of file TraCIServer.h.

References myCurrentSocket, mySockets, and myVehicleStateChanges.

Referenced by TraCIServerAPI_Simulation::writeVehicleStateIDs(), and TraCIServerAPI_Simulation::writeVehicleStateNumber().

Here is the caller graph for this function:

◆ getWrapperStorage()

tcpip::Storage & TraCIServer::getWrapperStorage ( )

Definition at line 226 of file TraCIServer.cpp.

References myWrapperStorage.

Here is the caller graph for this function:

◆ initialiseSubscription()

void TraCIServer::initialiseSubscription ( libsumo::Subscription & s )

private

Definition at line 1067 of file TraCIServer.cpp.

References libsumo::Subscription::beginTime, libsumo::Subscription::commandId, libsumo::Subscription::endTime, MSNet::getCurrentTimeStep(), MSNet::getInstance(), libsumo::Subscription::isVehicleToPersonContextSubscription(), libsumo::Subscription::isVehicleToVehicleContextSubscription(), myLastContextSubscription, myOutputStorage, mySubscriptionCache, mySubscriptions, libsumo::Helper::needNewSubscription(), processSingleSubscription(), tcpip::Storage::readByte(), tcpip::Storage::readInt(), tcpip::Storage::reset(), libsumo::RTYPE_ERR, libsumo::RTYPE_OK, tcpip::Storage::size(), tcpip::Storage::valid_pos(), tcpip::Storage::writeByte(), tcpip::Storage::writeInt(), writeStatusCmd(), and tcpip::Storage::writeStorage().

Referenced by addObjectVariableSubscription().

Here is the caller graph for this function:

◆ initWrapper()

void TraCIServer::initWrapper	(	const int	domainID,
		const int	variable,
		const std::string &	objID
	)

Definition at line 112 of file TraCIServer.cpp.

References myWrapperStorage, tcpip::Storage::reset(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Here is the caller graph for this function:

◆ nextTargetTime()

SUMOTime TraCIServer::nextTargetTime ( ) const

private

get the minimal next target time among all clients

Definition at line 537 of file TraCIServer.cpp.

References MIN2(), and mySockets.

Referenced by processCommands().

Here is the caller graph for this function:

◆ openSocket()

void TraCIServer::openSocket ( const std::map< int, CmdExecutor > & execs )

static

Initialises the server.

Parameters

[in] execs The (additional) command executors to use

Definition at line 372 of file TraCIServer.cpp.

References MSNet::addTransportableStateListener(), MSNet::addVehicleStateListener(), MSNet::getInstance(), OptionsCont::getOptions(), myDoCloseConnection, myExecutors, myInstance, mySubscriptionCache, string2time(), TraCIServer(), and tcpip::Storage::writeInt().

Referenced by NLBuilder::init(), and GUILoadThread::run().

Here is the caller graph for this function:

◆ operator=()

TraCIServer& TraCIServer::operator= ( const TraCIServer & s )

privatedelete

Invalidated assignment operator.

◆ postProcessSimulationStep()

void TraCIServer::postProcessSimulationStep ( )

private

Handles subscriptions to send after a simstep2 command.

Definition at line 959 of file TraCIServer.cpp.

References MSNet::ARRIVED, libsumo::Subscription::beginTime, libsumo::CMD_SIMSTEP, libsumo::CMD_SUBSCRIBE_PERSON_CONTEXT, libsumo::CMD_SUBSCRIBE_PERSON_VARIABLE, libsumo::CMD_SUBSCRIBE_VEHICLE_CONTEXT, libsumo::CMD_SUBSCRIBE_VEHICLE_VARIABLE, libsumo::Subscription::commandId, libsumo::Subscription::endTime, MSTransportableControl::get(), MSNet::getCurrentTimeStep(), MSNet::getInstance(), MSNet::getPersonControl(), libsumo::Subscription::id, myOutputStorage, mySubscriptionCache, mySubscriptions, myVehicleStateChanges, processSingleSubscription(), tcpip::Storage::reset(), libsumo::RTYPE_OK, tcpip::Storage::size(), tcpip::Storage::writeInt(), writeStatusCmd(), and tcpip::Storage::writeStorage().

Referenced by processCommands().

Here is the caller graph for this function:

◆ processCommands()

int TraCIServer::processCommands	(	const SUMOTime	step,
		const bool	afterMove = `false`
	)

process all commands until the next SUMO simulation step. It is guaranteed that t->getTargetTime() >= myStep after call (except the case that a load or close command is received)s

Definition at line 583 of file TraCIServer.cpp.

References libsumo::CMD_CLOSE, libsumo::CMD_EXECUTEMOVE, libsumo::CMD_LOAD, libsumo::CMD_SIMSTEP, dispatchCommand(), MSNet::getInstance(), myCurrentSocket, myDoCloseConnection, myInputStorage, myLoadArgs, myOutputStorage, mySockets, myTargetTime, myTransportableStateChanges, myVehicleStateChanges, nextTargetTime(), postProcessSimulationStep(), processReorderingRequests(), tcpip::Storage::reset(), sendOutputToAll(), SIMTIME, tcpip::Storage::size(), and tcpip::Storage::valid_pos().

Referenced by MSNet::simulationStep().

Here is the caller graph for this function:

◆ processReorderingRequests()

void TraCIServer::processReorderingRequests ( )

private

checks for and processes reordering requests (relevant for multiple clients)

Definition at line 493 of file TraCIServer.cpp.

References mySocketReorderRequests, mySockets, and SIMTIME.

Referenced by processCommands().

Here is the caller graph for this function:

◆ processSingleSubscription()

bool TraCIServer::processSingleSubscription	(	const libsumo::Subscription &	s,
		tcpip::Storage &	writeInto,
		std::string &	errors
	)

private

Definition at line 1138 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, libsumo::Helper::applySubscriptionFilters(), libsumo::Helper::collectObjectIDsInRange(), libsumo::Subscription::commandId, libsumo::Subscription::contextDomain, libsumo::Helper::findObjectShape(), libsumo::Subscription::id, myExecutors, libsumo::Subscription::parameters, libsumo::Subscription::range, tcpip::Storage::readInt(), tcpip::Storage::readString(), tcpip::Storage::readUnsignedByte(), libsumo::RTYPE_ERR, libsumo::RTYPE_NOTIMPLEMENTED, libsumo::RTYPE_OK, tcpip::Storage::size(), libsumo::SUBS_FILTER_NO_RTREE, libsumo::TRACI_ID_LIST, libsumo::TYPE_STRING, libsumo::Subscription::variables, tcpip::Storage::writeChar(), tcpip::Storage::writeInt(), writeStatusCmd(), tcpip::Storage::writeStorage(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Referenced by initialiseSubscription(), and postProcessSimulationStep().

Here is the caller graph for this function:

◆ readCommandID()

int TraCIServer::readCommandID	(	int &	commandStart,
		int &	commandLength
	)

private

Reads the next command ID from the input storage.

Returns: the command ID

Parameters

[out] the version with reference parameters provides information on the command start position and length used in dispatchCommand for checking purposes

Definition at line 736 of file TraCIServer.cpp.

References tcpip::Storage::begin(), tcpip::Storage::end(), myInputStorage, tcpip::Storage::position(), tcpip::Storage::readInt(), and tcpip::Storage::readUnsignedByte().

Referenced by checkClientOrdering(), and dispatchCommand().

Here is the caller graph for this function:

◆ readTypeCheckingByte()

bool TraCIServer::readTypeCheckingByte	(	tcpip::Storage &	inputStorage,
		int &	into
	)

Reads the value type and a byte, verifying the type.

Parameters

	[in,changed]	inputStorage The storage to read from
[out]	into	Holder of the read value

Returns: Whether a byte was given (by data type)

Definition at line 1583 of file TraCIServer.cpp.

References tcpip::Storage::readByte(), and libsumo::TYPE_BYTE.

Referenced by TraCIServerAPI_Vehicle::insertReplaceStop(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_Person::processSet(), and TraCIServerAPI_Vehicle::processSet().

Here is the caller graph for this function:

◆ readTypeCheckingColor()

bool TraCIServer::readTypeCheckingColor	(	tcpip::Storage &	inputStorage,
		libsumo::TraCIColor &	into
	)

Reads the value type and a color, verifying the type.

Parameters

	[in,changed]	inputStorage The storage to read from
[out]	into	Holder of the read value

Returns: Whether a color was given (by data type)

Definition at line 1558 of file TraCIServer.cpp.

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

Referenced by TraCIServerAPI_Person::processSet(), TraCIServerAPI_POI::processSet(), TraCIServerAPI_Polygon::processSet(), TraCIServerAPI_Vehicle::processSet(), and TraCIServerAPI_VehicleType::setVariable().

Here is the caller graph for this function:

◆ readTypeCheckingDouble()

bool TraCIServer::readTypeCheckingDouble	(	tcpip::Storage &	inputStorage,
		double &	into
	)

Reads the value type and a double, verifying the type.

Parameters

	[in,changed]	inputStorage The storage to read from
[out]	into	Holder of the read value

Returns: Whether a double value was given (by data type)

Definition at line 1518 of file TraCIServer.cpp.

References tcpip::Storage::readDouble(), tcpip::Storage::readUnsignedByte(), and libsumo::TYPE_DOUBLE.

Referenced by TraCIServerAPI_Vehicle::insertReplaceStop(), TraCIServerAPI_Simulation::processGet(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_GUI::processSet(), TraCIServerAPI_InductionLoop::processSet(), TraCIServerAPI_Person::processSet(), TraCIServerAPI_POI::processSet(), TraCIServerAPI_Polygon::processSet(), TraCIServerAPI_Simulation::processSet(), TraCIServerAPI_TrafficLight::processSet(), TraCIServerAPI_Vehicle::processSet(), and TraCIServerAPI_VehicleType::setVariable().

Here is the caller graph for this function:

◆ readTypeCheckingDoubleList()

bool TraCIServer::readTypeCheckingDoubleList	(	tcpip::Storage &	inputStorage,
		std::vector< double > &	into
	)

Reads the value type and a double list, verifying the type.

Parameters

	[in,changed]	inputStorage The storage to read from
[out]	into	Holder of the read value

Returns: Whether a double value was given (by data type)

Definition at line 1548 of file TraCIServer.cpp.

References tcpip::Storage::readDoubleList(), tcpip::Storage::readUnsignedByte(), and libsumo::TYPE_DOUBLELIST.

Referenced by TraCIServerAPI_Polygon::processSet().

Here is the caller graph for this function:

◆ readTypeCheckingInt()

bool TraCIServer::readTypeCheckingInt	(	tcpip::Storage &	inputStorage,
		int &	into
	)

Reads the value type and an int, verifying the type.

Parameters

	[in,changed]	inputStorage The storage to read from
[out]	into	Holder of the read value

Returns: Whether an integer value was given (by data type)

Definition at line 1508 of file TraCIServer.cpp.

References tcpip::Storage::readInt(), tcpip::Storage::readUnsignedByte(), and libsumo::TYPE_INTEGER.

Referenced by TraCIServerAPI_Vehicle::insertReplaceStop(), TraCIServerAPI_Person::processGet(), TraCIServerAPI_Simulation::processGet(), TraCIServerAPI_TrafficLight::processGet(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_GUI::processSet(), TraCIServerAPI_LaneArea::processSet(), TraCIServerAPI_Person::processSet(), TraCIServerAPI_POI::processSet(), TraCIServerAPI_Polygon::processSet(), TraCIServerAPI_TrafficLight::processSet(), and TraCIServerAPI_Vehicle::processSet().

Here is the caller graph for this function:

◆ readTypeCheckingPolygon()

bool TraCIServer::readTypeCheckingPolygon	(	tcpip::Storage &	inputStorage,
		PositionVector &	into
	)

Reads the value type and a polygon, verifying the type.

Parameters

	[in,changed]	inputStorage The storage to read from
[out]	into	Holder of the read value

Returns: Whether an unsigned byte was given (by data type)

Definition at line 1603 of file TraCIServer.cpp.

References tcpip::Storage::readDouble(), tcpip::Storage::readInt(), tcpip::Storage::readUnsignedByte(), and libsumo::TYPE_POLYGON.

Referenced by TraCIServerAPI_GUI::processSet(), and TraCIServerAPI_Polygon::processSet().

Here is the caller graph for this function:

◆ readTypeCheckingPosition2D()

bool TraCIServer::readTypeCheckingPosition2D	(	tcpip::Storage &	inputStorage,
		libsumo::TraCIPosition &	into
	)

Reads the value type and a 2D position, verifying the type.

Parameters

	[in,changed]	inputStorage The storage to read from
[out]	into	Holder of the read value

Returns: Whether a 2D position was given (by data type)

Definition at line 1571 of file TraCIServer.cpp.

References libsumo::POSITION_2D, tcpip::Storage::readDouble(), tcpip::Storage::readUnsignedByte(), libsumo::TraCIPosition::x, libsumo::TraCIPosition::y, and libsumo::TraCIPosition::z.

Referenced by TraCIServerAPI_GUI::processSet(), and TraCIServerAPI_POI::processSet().

Here is the caller graph for this function:

◆ readTypeCheckingString()

bool TraCIServer::readTypeCheckingString	(	tcpip::Storage &	inputStorage,
		std::string &	into
	)

Reads the value type and a string, verifying the type.

Parameters

	[in,changed]	inputStorage The storage to read from
[out]	into	Holder of the read value

Returns: Whether a string value was given (by data type)

Definition at line 1528 of file TraCIServer.cpp.

References tcpip::Storage::readString(), tcpip::Storage::readUnsignedByte(), and libsumo::TYPE_STRING.

Here is the caller graph for this function:

◆ readTypeCheckingStringList()

bool TraCIServer::readTypeCheckingStringList	(	tcpip::Storage &	inputStorage,
		std::vector< std::string > &	into
	)

Reads the value type and a string list, verifying the type.

Parameters

	[in,changed]	inputStorage The storage to read from
[out]	into	Holder of the read value

Returns: Whether a double value was given (by data type)

Definition at line 1538 of file TraCIServer.cpp.

References tcpip::Storage::readStringList(), tcpip::Storage::readUnsignedByte(), and libsumo::TYPE_STRINGLIST.

Referenced by dispatchCommand(), TraCIServerAPI_Person::processGet(), TraCIServerAPI_Person::processSet(), TraCIServerAPI_Route::processSet(), TraCIServerAPI_TrafficLight::processSet(), and TraCIServerAPI_Vehicle::processSet().

Here is the caller graph for this function:

◆ readTypeCheckingUnsignedByte()

bool TraCIServer::readTypeCheckingUnsignedByte	(	tcpip::Storage &	inputStorage,
		int &	into
	)

Reads the value type and an unsigned byte, verifying the type.

Parameters

	[in,changed]	inputStorage The storage to read from
[out]	into	Holder of the read value

Returns: Whether an unsigned byte was given (by data type)

Definition at line 1593 of file TraCIServer.cpp.

References tcpip::Storage::readUnsignedByte(), and libsumo::TYPE_UBYTE.

Referenced by TraCIServerAPI_Simulation::commandPositionConversion(), TraCIServerAPI_Vehicle::processGet(), TraCIServerAPI_POI::processSet(), TraCIServerAPI_Polygon::processSet(), and TraCIServerAPI_Vehicle::processSet().

Here is the caller graph for this function:

◆ removeCurrentSocket()

std::map< int, TraCIServer::SocketInfo * >::iterator TraCIServer::removeCurrentSocket ( )

private

removes myCurrentSocket from mySockets and returns an iterator pointing to the next member according to the ordering

Definition at line 724 of file TraCIServer.cpp.

References myCurrentSocket, and mySockets.

Referenced by dispatchCommand().

Here is the caller graph for this function:

◆ removeFilters()

void TraCIServer::removeFilters ( )

private

Definition at line 1384 of file TraCIServer.cpp.

References libsumo::Subscription::activeFilters, myLastContextSubscription, and libsumo::SUBS_FILTER_NONE.

Referenced by addSubscriptionFilter().

Here is the caller graph for this function:

◆ removeSubscription()

void TraCIServer::removeSubscription	(	int	commandId,
		const std::string &	identity,
		int	domain
	)

private

Definition at line 1113 of file TraCIServer.cpp.

References myLastContextSubscription, mySubscriptions, libsumo::RTYPE_ERR, libsumo::RTYPE_OK, and writeStatusCmd().

Referenced by addObjectVariableSubscription().

Here is the caller graph for this function:

◆ sendOutputToAll()

void TraCIServer::sendOutputToAll ( ) const

private

send out subscription results (actually just the content of myOutputStorage) to clients which will act in this step (i.e. with client target time <= myTargetTime)

Definition at line 561 of file TraCIServer.cpp.

References MSNet::getCurrentTimeStep(), MSNet::getInstance(), myOutputStorage, and mySockets.

Referenced by processCommands().

Here is the caller graph for this function:

◆ sendSingleSimStepResponse()

void TraCIServer::sendSingleSimStepResponse ( )

private

sends an empty response to a simstep command to the current client. (This applies to a situation where the TraCI step frequency is higher than the SUMO step frequency)

Definition at line 1019 of file TraCIServer.cpp.

References libsumo::CMD_SIMSTEP, myCurrentSocket, myOutputStorage, mySubscriptionCache, tcpip::Storage::reset(), libsumo::RTYPE_OK, tcpip::Storage::size(), writeStatusCmd(), and tcpip::Storage::writeStorage().

Referenced by dispatchCommand().

Here is the caller graph for this function:

◆ setContext()

virtual void libsumo::VariableWrapper::setContext ( const std::string * const )

inlinevirtualinherited

Reimplemented in libsumo::Helper::SubscriptionWrapper.

Definition at line 157 of file Subscription.h.

Referenced by libsumo::Helper::handleSingleSubscription().

Here is the caller graph for this function:

◆ stateLoaded()

void TraCIServer::stateLoaded ( SUMOTime targetTime )

updates myTargetTime and resets vehicle state changes after loading a simulation state

Note: Used in MSStateHandler to update the server's time after loading a state

Definition at line 1626 of file TraCIServer.cpp.

References mySockets, mySubscriptionCache, mySubscriptions, myTargetTime, and tcpip::Storage::reset().

Referenced by NLBuilder::build(), and TraCIServerAPI_Simulation::processSet().

Here is the caller graph for this function:

◆ transportableStateChanged()

void TraCIServer::transportableStateChanged	(	const MSTransportable *const	transportable,
		MSNet::TransportableState	to,
		const std::string &	info = `""`
	)

virtual

Called if a transportable changes its state.

Parameters

[in]	transportable	The transportable which changed its state
[in]	to	The state the transportable has changed to
[in]	info	Additional information on the state change

Implements MSNet::TransportableStateListener.

Definition at line 422 of file TraCIServer.cpp.

References Named::getID(), myDoCloseConnection, mySockets, and myTransportableStateChanges.

◆ vehicleStateChanged()

void TraCIServer::vehicleStateChanged	(	const SUMOVehicle *const	vehicle,
		MSNet::VehicleState	to,
		const std::string &	info = `""`
	)

virtual

Called if a vehicle changes its state.

Parameters

[in]	vehicle	The vehicle which changed its state
[in]	to	The state the vehicle has changed to
[in]	info	Additional information on the state change

Implements MSNet::VehicleStateListener.

Definition at line 411 of file TraCIServer.cpp.

References Named::getID(), myDoCloseConnection, mySockets, and myVehicleStateChanges.

◆ wasClosed()

bool TraCIServer::wasClosed ( )

static

check whether close was requested

Returns: Whether the connection was closed

Definition at line 402 of file TraCIServer.cpp.

References myDoCloseConnection.

Referenced by MSNet::adaptToState(), MSNet::simulationState(), and MSNet::simulationStep().

Here is the caller graph for this function:

◆ wrapColor()

bool TraCIServer::wrapColor	(	const std::string &	objID,
		const int	variable,
		const libsumo::TraCIColor &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 191 of file TraCIServer.cpp.

References myWrapperStorage, libsumo::TYPE_COLOR, and tcpip::Storage::writeUnsignedByte().

◆ wrapDouble()

bool TraCIServer::wrapDouble	(	const std::string &	objID,
		const int	variable,
		const double	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 121 of file TraCIServer.cpp.

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

◆ wrapDoubleList()

bool TraCIServer::wrapDoubleList	(	const std::string &	objID,
		const int	variable,
		const std::vector< double > &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 153 of file TraCIServer.cpp.

References myWrapperStorage, libsumo::TYPE_DOUBLELIST, tcpip::Storage::writeDoubleList(), and tcpip::Storage::writeUnsignedByte().

◆ wrapInt()

bool TraCIServer::wrapInt	(	const std::string &	objID,
		const int	variable,
		const int	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 129 of file TraCIServer.cpp.

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

◆ wrapPosition()

bool TraCIServer::wrapPosition	(	const std::string &	objID,
		const int	variable,
		const libsumo::TraCIPosition &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 161 of file TraCIServer.cpp.

References myWrapperStorage, libsumo::POSITION_2D, libsumo::POSITION_3D, libsumo::VAR_POSITION3D, tcpip::Storage::writeDouble(), and tcpip::Storage::writeUnsignedByte().

◆ wrapPositionVector()

bool TraCIServer::wrapPositionVector	(	const std::string &	objID,
		const int	variable,
		const libsumo::TraCIPositionVector &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 174 of file TraCIServer.cpp.

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

◆ wrapString()

bool TraCIServer::wrapString	(	const std::string &	objID,
		const int	variable,
		const std::string &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 137 of file TraCIServer.cpp.

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

◆ wrapStringDoublePair()

bool TraCIServer::wrapStringDoublePair	(	const std::string &	objID,
		const int	variable,
		const std::pair< std::string, double > &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 202 of file TraCIServer.cpp.

References myWrapperStorage, libsumo::TYPE_COMPOUND, libsumo::TYPE_DOUBLE, libsumo::TYPE_STRING, tcpip::Storage::writeDouble(), tcpip::Storage::writeInt(), tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

◆ wrapStringList()

bool TraCIServer::wrapStringList	(	const std::string &	objID,
		const int	variable,
		const std::vector< std::string > &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 145 of file TraCIServer.cpp.

References myWrapperStorage, libsumo::TYPE_STRINGLIST, tcpip::Storage::writeStringList(), and tcpip::Storage::writeUnsignedByte().

◆ wrapStringPair()

bool TraCIServer::wrapStringPair	(	const std::string &	objID,
		const int	variable,
		const std::pair< std::string, std::string > &	value
	)

virtual

Implements libsumo::VariableWrapper.

Definition at line 214 of file TraCIServer.cpp.

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

◆ writeErrorStatusCmd()

bool TraCIServer::writeErrorStatusCmd	(	int	commandId,
		const std::string &	description,
		tcpip::Storage &	outputStorage
	)

Writes a status command to the given storage with status = RTYPE_ERR.

Parameters

[in]	commandId	The id of the command to respond to
[in]	description	The status description (error message, for example)
	[in,filled]	outputStorage The storage to write the status into

Definition at line 1060 of file TraCIServer.cpp.

References libsumo::RTYPE_ERR, and writeStatusCmd().

◆ writePositionVector()

void TraCIServer::writePositionVector	(	tcpip::Storage &	outputStorage,
		const libsumo::TraCIPositionVector &	shape
	)

Definition at line 1492 of file TraCIServer.cpp.

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

◆ writeResponseWithLength()

void TraCIServer::writeResponseWithLength	(	tcpip::Storage &	outputStorage,
		tcpip::Storage &	tempMsg
	)

Definition at line 1480 of file TraCIServer.cpp.

References tcpip::Storage::size(), tcpip::Storage::writeInt(), tcpip::Storage::writeStorage(), and tcpip::Storage::writeUnsignedByte().

Here is the caller graph for this function:

◆ writeStatusCmd() [1/2]

void TraCIServer::writeStatusCmd	(	int	commandId,
		int	status,
		const std::string &	description
	)

Writes a status command to myOutputStorage.

Parameters

[in]	commandId	The id of the command to respond to
[in]	status	The status to send
[in]	description	The status description (error message, for example)

Definition at line 1040 of file TraCIServer.cpp.

References myOutputStorage, and writeStatusCmd().

◆ writeStatusCmd() [2/2]

void TraCIServer::writeStatusCmd	(	int	commandId,
		int	status,
		const std::string &	description,
		tcpip::Storage &	outputStorage
	)

Writes a status command to the given storage.

Parameters

[in]	commandId	The id of the command to respond to
[in]	status	The status to send
[in]	description	The status description (error message, for example)
	[in,filled]	outputStorage The storage to write the status into

Definition at line 1046 of file TraCIServer.cpp.

References libsumo::RTYPE_ERR, libsumo::RTYPE_NOTIMPLEMENTED, toHex(), WRITE_ERROR, tcpip::Storage::writeString(), and tcpip::Storage::writeUnsignedByte().

Field Documentation

◆ handle

SubscriptionHandler libsumo::VariableWrapper::handle

inherited

Definition at line 156 of file Subscription.h.

◆ myCurrentSocket

std::map<int, SocketInfo*>::iterator TraCIServer::myCurrentSocket

private

The currently active client socket.

Definition at line 371 of file TraCIServer.h.

Referenced by checkClientOrdering(), cleanup(), dispatchCommand(), getTransportableStateChanges(), getVehicleStateChanges(), processCommands(), removeCurrentSocket(), sendSingleSimStepResponse(), and TraCIServer().

◆ myDoCloseConnection

bool TraCIServer::myDoCloseConnection = false

staticprivate

Whether the connection was set to be to close.

Definition at line 361 of file TraCIServer.h.

Referenced by close(), dispatchCommand(), openSocket(), processCommands(), TraCIServer(), transportableStateChanged(), vehicleStateChanged(), and wasClosed().

◆ myExecutors

std::map<int, CmdExecutor> TraCIServer::myExecutors

private

Map of commandIds -> their executors; applicable if the executor applies to the method footprint.

Definition at line 389 of file TraCIServer.h.

Referenced by dispatchCommand(), openSocket(), processSingleSubscription(), and TraCIServer().

◆ myInputStorage

tcpip::Storage TraCIServer::myInputStorage

private

The storage to read from.

Definition at line 377 of file TraCIServer.h.

Referenced by addObjectVariableSubscription(), addSubscriptionFilter(), checkClientOrdering(), cleanup(), dispatchCommand(), processCommands(), and readCommandID().

◆ myInstance

TraCIServer * TraCIServer::myInstance = nullptr

staticprivate

Singleton instance of the server.

Definition at line 358 of file TraCIServer.h.

Referenced by close(), getInstance(), and openSocket().

◆ myLastContextSubscription

libsumo::Subscription* TraCIServer::myLastContextSubscription

private

The last modified context subscription (the one to add a filter to, see @addSubscriptionFilter(), currently only for vehicle to vehicle context)

Definition at line 400 of file TraCIServer.h.

Referenced by addSubscriptionFilter(), addSubscriptionFilterDownstreamDistance(), addSubscriptionFilterFieldOfVision(), addSubscriptionFilterLanes(), addSubscriptionFilterLateralDistance(), addSubscriptionFilterLeadFollow(), addSubscriptionFilterNoOpposite(), addSubscriptionFilterTurn(), addSubscriptionFilterUpstreamDistance(), addSubscriptionFilterVClass(), addSubscriptionFilterVType(), initialiseSubscription(), removeFilters(), and removeSubscription().

◆ myLoadArgs

std::vector<std::string> TraCIServer::myLoadArgs

private

Definition at line 394 of file TraCIServer.h.

Referenced by dispatchCommand(), getLoadArgs(), and processCommands().

◆ myOutputStorage

tcpip::Storage TraCIServer::myOutputStorage

private

The storage to write to.

Definition at line 380 of file TraCIServer.h.

Referenced by checkClientOrdering(), cleanup(), commandGetVersion(), dispatchCommand(), initialiseSubscription(), postProcessSimulationStep(), processCommands(), sendOutputToAll(), sendSingleSimStepResponse(), and writeStatusCmd().

◆ myParameterized

std::set<std::pair<int, int> > TraCIServer::myParameterized

private

Set of variables which have parameters.

Definition at line 392 of file TraCIServer.h.

Referenced by addObjectVariableSubscription(), and TraCIServer().

◆ mySocketReorderRequests

std::map<int, SocketInfo*> TraCIServer::mySocketReorderRequests

private

This stores the setOrder(int) requests of the clients.

Definition at line 368 of file TraCIServer.h.

Referenced by dispatchCommand(), and processReorderingRequests().

◆ mySockets

std::map<int, SocketInfo*> TraCIServer::mySockets

private

The socket connections to the clients the first component (index) determines the client's order (lowest index's commands are processed first),.

See also: CMD_SETORDER

Definition at line 365 of file TraCIServer.h.

Referenced by checkClientOrdering(), cleanup(), dispatchCommand(), getTransportableStateChanges(), getVehicleStateChanges(), nextTargetTime(), processCommands(), processReorderingRequests(), removeCurrentSocket(), sendOutputToAll(), stateLoaded(), TraCIServer(), transportableStateChanged(), vehicleStateChanged(), and ~TraCIServer().

◆ mySubscriptionCache

tcpip::Storage TraCIServer::mySubscriptionCache

private

The last timestep's subscription results.

Definition at line 386 of file TraCIServer.h.

Referenced by cleanup(), initialiseSubscription(), openSocket(), postProcessSimulationStep(), sendSingleSimStepResponse(), and stateLoaded().

◆ mySubscriptions

std::vector<libsumo::Subscription> TraCIServer::mySubscriptions

private

The list of known, still valid subscriptions.

Definition at line 397 of file TraCIServer.h.

Referenced by cleanup(), initialiseSubscription(), postProcessSimulationStep(), removeSubscription(), and stateLoaded().

◆ myTargetTime

SUMOTime TraCIServer::myTargetTime

private

The time step to reach until processing the next commands.

Definition at line 374 of file TraCIServer.h.

Referenced by cleanup(), getTargetTime(), processCommands(), and stateLoaded().

◆ myTransportableStateChanges

std::map<MSNet::TransportableState, std::vector<std::string> > TraCIServer::myTransportableStateChanges

private

Changes in the states of simulated transportables.

Note: Server cache myTransportableStateChanges is used for managing last steps subscription updates and for client information in case that myAmEmbedded==true, which implies a single client. For the potential multiclient case (myAmEmbedded==false), each socket in mySockets is associated with a proper TransportableStateChanges container mySockets[...].second->TransportableStateChanges Performance could be improved if for a single client, myTransportableStateChanges is used only.

Definition at line 418 of file TraCIServer.h.

Referenced by cleanup(), getTransportableStateChanges(), processCommands(), TraCIServer(), and transportableStateChanged().

◆ myVehicleStateChanges

std::map<MSNet::VehicleState, std::vector<std::string> > TraCIServer::myVehicleStateChanges

private

Changes in the states of simulated vehicles.

Note: Server cache myVehicleStateChanges is used for managing last steps subscription updates and for client information in case that myAmEmbedded==true, which implies a single client. For the potential multiclient case (myAmEmbedded==false), each socket in mySockets is associated with a proper vehicleStateChanges container mySockets[...].second->vehicleStateChanges Performance could be improved if for a single client, myVehicleStateChanges is used only.

Definition at line 409 of file TraCIServer.h.

Referenced by cleanup(), getVehicleStateChanges(), postProcessSimulationStep(), processCommands(), TraCIServer(), and vehicleStateChanged().

◆ myWrapperStorage

tcpip::Storage TraCIServer::myWrapperStorage

private

A temporary storage to let the wrapper write to.

Definition at line 383 of file TraCIServer.h.

Referenced by getWrapperStorage(), initWrapper(), wrapColor(), wrapDouble(), wrapDoubleList(), wrapInt(), wrapPosition(), wrapPositionVector(), wrapString(), wrapStringDoublePair(), wrapStringList(), and wrapStringPair().

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

Data Structures

Public Types

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ CmdExecutor

◆ SubscriptionHandler

Constructor & Destructor Documentation

◆ TraCIServer()

◆ ~TraCIServer()

Member Function Documentation

◆ addObjectVariableSubscription()

◆ addSubscriptionFilter()

◆ addSubscriptionFilterDownstreamDistance()

◆ addSubscriptionFilterFieldOfVision()

◆ addSubscriptionFilterLanes()

◆ addSubscriptionFilterLateralDistance()

◆ addSubscriptionFilterLeadFollow()

◆ addSubscriptionFilterNoOpposite()

◆ addSubscriptionFilterTurn()

◆ addSubscriptionFilterUpstreamDistance()

◆ addSubscriptionFilterVClass()

◆ addSubscriptionFilterVType()

◆ centralObject()

◆ checkClientOrdering()

◆ cleanup()

◆ clear()

◆ close()

◆ commandGetVersion()

◆ dispatchCommand()

◆ empty()

◆ getInstance()

◆ getLoadArgs()

◆ getTargetTime()

◆ getTransportableStateChanges()

◆ getVehicleStateChanges()

◆ getWrapperStorage()

◆ initialiseSubscription()

◆ initWrapper()

◆ nextTargetTime()

◆ openSocket()

◆ operator=()

◆ postProcessSimulationStep()

◆ processCommands()

◆ processReorderingRequests()

◆ processSingleSubscription()

◆ readCommandID()

◆ readTypeCheckingByte()

◆ readTypeCheckingColor()

◆ readTypeCheckingDouble()

◆ readTypeCheckingDoubleList()

◆ readTypeCheckingInt()

◆ readTypeCheckingPolygon()

◆ readTypeCheckingPosition2D()

◆ readTypeCheckingString()

◆ readTypeCheckingStringList()

◆ readTypeCheckingUnsignedByte()

◆ removeCurrentSocket()

◆ removeFilters()

◆ removeSubscription()

◆ sendOutputToAll()

◆ sendSingleSimStepResponse()

◆ setContext()

◆ stateLoaded()

◆ transportableStateChanged()

◆ vehicleStateChanged()

◆ wasClosed()

◆ wrapColor()

◆ wrapDouble()

◆ wrapDoubleList()

◆ wrapInt()

◆ wrapPosition()

◆ wrapPositionVector()

◆ wrapString()

◆ wrapStringDoublePair()