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

Scope for interaction with the simulation. More...

#include <TraCIAPI.h>

Inheritance diagram for TraCIAPI::SimulationScope:
Inheritance graph
Collaboration diagram for TraCIAPI::SimulationScope:
Collaboration graph

Public Member Functions

std::vector< std::string > getArrivedIDList () const
 
int getArrivedNumber () const
 
SubscribedContextValues getContextSubscriptionResults ()
 
SubscribedValues getContextSubscriptionResults (const std::string &objID)
 
SUMOTime getCurrentTime () const
 
SUMOTime getDeltaT () const
 
std::vector< std::string > getDepartedIDList () const
 
int getDepartedNumber () const
 
std::vector< std::string > getEndingTeleportIDList () const
 
int getEndingTeleportNumber () const
 
std::vector< std::string > getLoadedIDList () const
 
int getLoadedNumber () const
 
int getMinExpectedNumber () const
 
TraCIBoundary getNetBoundary () const
 
std::vector< std::string > getStartingTeleportIDList () const
 
int getStartingTeleportNumber () const
 
SubscribedValues getSubscriptionResults ()
 
TraCIValues getSubscriptionResults (const std::string &objID)
 
 SimulationScope (TraCIAPI &parent)
 
void subscribe (int domID, const std::string &objID, SUMOTime beginTime, SUMOTime endTime, const std::vector< int > &vars) const
 
void subscribeContext (int domID, const std::string &objID, SUMOTime beginTime, SUMOTime endTime, int domain, SUMOReal range, const std::vector< int > &vars) const
 
virtual ~SimulationScope ()
 

Protected Attributes

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

Private Member Functions

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

Detailed Description

Scope for interaction with the simulation.

Definition at line 568 of file TraCIAPI.h.

Constructor & Destructor Documentation

§ SimulationScope() [1/2]

TraCIAPI::SimulationScope::SimulationScope ( TraCIAPI &  parent)
inline

Definition at line 570 of file TraCIAPI.h.

§ ~SimulationScope()

virtual TraCIAPI::SimulationScope::~SimulationScope ( )
inlinevirtual

Definition at line 571 of file TraCIAPI.h.

References SUMOReal.

§ SimulationScope() [2/2]

TraCIAPI::SimulationScope::SimulationScope ( const SimulationScope &  src)
private

invalidated copy constructor

Member Function Documentation

§ getArrivedIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getArrivedIDList ( ) const

Definition at line 1353 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_ARRIVED_VEHICLES_IDS.

§ getArrivedNumber()

int TraCIAPI::SimulationScope::getArrivedNumber ( ) const

Definition at line 1348 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_ARRIVED_VEHICLES_NUMBER.

§ getContextSubscriptionResults() [1/2]

TraCIAPI::SubscribedContextValues TraCIAPI::SimulationScope::getContextSubscriptionResults ( )

Definition at line 1428 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

§ getContextSubscriptionResults() [2/2]

TraCIAPI::SubscribedValues TraCIAPI::SimulationScope::getContextSubscriptionResults ( const std::string &  objID)

Definition at line 1434 of file TraCIAPI.cpp.

§ getCurrentTime()

SUMOTime TraCIAPI::SimulationScope::getCurrentTime ( ) const

Definition at line 1323 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TIME_STEP.

Referenced by TraCITestClient::testAPI().

§ getDeltaT()

SUMOTime TraCIAPI::SimulationScope::getDeltaT ( ) const

Definition at line 1378 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_DELTA_T.

§ getDepartedIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getDepartedIDList ( ) const

Definition at line 1343 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_DEPARTED_VEHICLES_IDS.

§ getDepartedNumber()

int TraCIAPI::SimulationScope::getDepartedNumber ( ) const

Definition at line 1338 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_DEPARTED_VEHICLES_NUMBER.

§ getEndingTeleportIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getEndingTeleportIDList ( ) const

Definition at line 1373 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TELEPORT_ENDING_VEHICLES_IDS.

§ getEndingTeleportNumber()

int TraCIAPI::SimulationScope::getEndingTeleportNumber ( ) const

Definition at line 1368 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TELEPORT_ENDING_VEHICLES_NUMBER.

§ getLoadedIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getLoadedIDList ( ) const

Definition at line 1333 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_LOADED_VEHICLES_IDS.

§ getLoadedNumber()

int TraCIAPI::SimulationScope::getLoadedNumber ( ) const

Definition at line 1328 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_LOADED_VEHICLES_NUMBER.

§ getMinExpectedNumber()

int TraCIAPI::SimulationScope::getMinExpectedNumber ( ) const

Definition at line 1388 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_MIN_EXPECTED_VEHICLES.

§ getNetBoundary()

TraCIAPI::TraCIBoundary TraCIAPI::SimulationScope::getNetBoundary ( ) const

Definition at line 1383 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_NET_BOUNDING_BOX.

§ getStartingTeleportIDList()

std::vector< std::string > TraCIAPI::SimulationScope::getStartingTeleportIDList ( ) const

Definition at line 1363 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TELEPORT_STARTING_VEHICLES_IDS.

§ getStartingTeleportNumber()

int TraCIAPI::SimulationScope::getStartingTeleportNumber ( ) const

Definition at line 1358 of file TraCIAPI.cpp.

References CMD_GET_SIM_VARIABLE, and VAR_TELEPORT_STARTING_VEHICLES_NUMBER.

§ getSubscriptionResults() [1/2]

TraCIAPI::SubscribedValues TraCIAPI::SimulationScope::getSubscriptionResults ( )

Definition at line 1412 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

§ getSubscriptionResults() [2/2]

TraCIAPI::TraCIValues TraCIAPI::SimulationScope::getSubscriptionResults ( const std::string &  objID)

Definition at line 1418 of file TraCIAPI.cpp.

§ operator=()

SimulationScope& TraCIAPI::SimulationScope::operator= ( const SimulationScope &  src)
private

invalidated assignment operator

§ subscribe()

void TraCIAPI::SimulationScope::subscribe ( int  domID,
const std::string &  objID,
SUMOTime  beginTime,
SUMOTime  endTime,
const std::vector< int > &  vars 
) const

Definition at line 1393 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

§ subscribeContext()

void TraCIAPI::SimulationScope::subscribeContext ( int  domID,
const std::string &  objID,
SUMOTime  beginTime,
SUMOTime  endTime,
int  domain,
SUMOReal  range,
const std::vector< int > &  vars 
) const

Definition at line 1402 of file TraCIAPI.cpp.

Referenced by TraCITestClient::testAPI().

Field Documentation

§ myParent

TraCIAPI& TraCIAPI::TraCIScopeWrapper::myParent
protectedinherited

The parent TraCI client which offers the connection.

Definition at line 208 of file TraCIAPI.h.

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