sumointegrator::Sumo Class Reference

TraCIAPI client. More...

#include <include/sumo-integrator/core/Sumo.h>

Classes
class	Connection
	Exposes facilities related to the client-SUMO connection. More...
class	Ego
	Exposes facilities related to the ego entity. More...
class	Entities
	Exposes facilities related to SUMO's entities. More...
class	Simulation
	Exposes facilities related to SUMO's simulation. More...

Public Member Functions
	Sumo ()
	Construct a new Sumo object. More...
	~Sumo ()
	Destroy the Sumo object.

Public Attributes
std::unique_ptr< Connection >	connection
	Pointer to the Connection domain. More...
std::unique_ptr< Ego >	ego
	Pointer to the Ego domain. More...
std::unique_ptr< Entities >	entities
	Pointer to the Entities domain. More...
std::unique_ptr< Simulation >	simulation
	Pointer to the Simulation domain. More...

Detailed Description

TraCIAPI client.

Author

Mattia Affabris - matti.nosp@m.a.af.nosp@m.fabri.nosp@m.s@an.nosp@m.temot.nosp@m.ion..nosp@m.com

Date

2018-11-14

2018-11-29

Version

0.4.0-alpha4

6

Copyright

Copyright (C) (2018) AnteMotion

The client side of SUMO's client-server model, this class provides high-level interaction through SUMO's own C++ TraCIAPI library. TraCIAPI methods are wrapped into an organic and consistent interface, based on requirements specific to graphics-engine integration.

Functionality is divided in functionality domains, accessible as pointers to nested classes; each scope groups a specific set of functionality of the client interaction with SUMO:

• Connection
• Simulation
• Entities
• Ego

Note

Most TraCIAPI objects and methods are not accessible through this class: the corresponding wrapping facilities must be called instead. The following are exceptions:

• TraCIAPI::vehicle

Warning

In development, major changes are to be expected.

Inherits TraCIAPI.

Constructor & Destructor Documentation

Sumo()

sumointegrator::Sumo::Sumo

(

)

Construct a new Sumo object.

Multiple instances may exist at the same time: each acts as a separate client connected to SUMO's server instance.

Member Data Documentation

connection

std::unique_ptr<Connection> sumointegrator::Sumo::connection

Pointer to the Connection domain.

Sumo sumo;
sumo.connection->open();

ego

std::unique_ptr<Ego> sumointegrator::Sumo::ego

Pointer to the Ego domain.

Sumo sumo;
sumo.ego->move();

entities

std::unique_ptr<Entities> sumointegrator::Sumo::entities

Pointer to the Entities domain.

Sumo sumo;
sumo.entities->subscribe();

simulation

std::unique_ptr<Simulation> sumointegrator::Sumo::simulation

Pointer to the Simulation domain.

Sumo sumo;
sumo.entities->tick();

---

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

• include/sumo-integrator/core/Sumo.h
• src/core/Sumo.cpp