Eclipse SUMO - Simulation of Urban MObility
Public Types | Public Member Functions | Data Fields
libsumo::VariableWrapper Class Referenceabstract

#include <Subscription.h>

Inheritance diagram for libsumo::VariableWrapper:
Collaboration diagram for libsumo::VariableWrapper:

Public Types

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

Public Member Functions

virtual void clear ()
 
virtual void setContext (const std::string &)
 
 VariableWrapper (SubscriptionHandler handler=nullptr)
 
virtual bool wrapColor (const std::string &objID, const int variable, const TraCIColor &value)=0
 
virtual bool wrapDouble (const std::string &objID, const int variable, const double value)=0
 
virtual bool wrapInt (const std::string &objID, const int variable, const int value)=0
 
virtual bool wrapPosition (const std::string &objID, const int variable, const TraCIPosition &value)=0
 
virtual bool wrapRoadPosition (const std::string &objID, const int variable, const TraCIRoadPosition &value)=0
 
virtual bool wrapString (const std::string &objID, const int variable, const std::string &value)=0
 
virtual bool wrapStringList (const std::string &objID, const int variable, const std::vector< std::string > &value)=0
 

Data Fields

SubscriptionHandler handle
 

Detailed Description

Definition at line 132 of file Subscription.h.

Member Typedef Documentation

◆ SubscriptionHandler

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

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

Definition at line 135 of file Subscription.h.

Constructor & Destructor Documentation

◆ VariableWrapper()

libsumo::VariableWrapper::VariableWrapper ( SubscriptionHandler  handler = nullptr)
inline

Definition at line 136 of file Subscription.h.

Member Function Documentation

◆ clear()

virtual void libsumo::VariableWrapper::clear ( )
inlinevirtual

Reimplemented in libsumo::Helper::SubscriptionWrapper.

Definition at line 139 of file Subscription.h.

◆ setContext()

virtual void libsumo::VariableWrapper::setContext ( const std::string &  )
inlinevirtual

Reimplemented in libsumo::Helper::SubscriptionWrapper.

Definition at line 138 of file Subscription.h.

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

◆ wrapColor()

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

Implemented in libsumo::Helper::SubscriptionWrapper, and TraCIServer.

Referenced by libsumo::Polygon::handleVariable(), libsumo::POI::handleVariable(), libsumo::Person::handleVariable(), libsumo::VehicleType::handleVariable(), and libsumo::Vehicle::handleVariable().

◆ wrapDouble()

virtual bool libsumo::VariableWrapper::wrapDouble ( const std::string &  objID,
const int  variable,
const double  value 
)
pure virtual

Implemented in TraCIServer, and libsumo::Helper::SubscriptionWrapper.

Referenced by libsumo::MultiEntryExit::handleVariable(), libsumo::LaneArea::handleVariable(), libsumo::InductionLoop::handleVariable(), libsumo::TrafficLight::handleVariable(), libsumo::Polygon::handleVariable(), libsumo::POI::handleVariable(), libsumo::Edge::handleVariable(), libsumo::Person::handleVariable(), libsumo::Lane::handleVariable(), libsumo::VehicleType::handleVariable(), libsumo::Simulation::handleVariable(), and libsumo::Vehicle::handleVariable().

◆ wrapInt()

virtual bool libsumo::VariableWrapper::wrapInt ( const std::string &  objID,
const int  variable,
const int  value 
)
pure virtual

Implemented in TraCIServer, and libsumo::Helper::SubscriptionWrapper.

Referenced by libsumo::MultiEntryExit::handleVariable(), libsumo::LaneArea::handleVariable(), libsumo::Route::handleVariable(), libsumo::Junction::handleVariable(), libsumo::InductionLoop::handleVariable(), libsumo::TrafficLight::handleVariable(), libsumo::Polygon::handleVariable(), libsumo::POI::handleVariable(), libsumo::Edge::handleVariable(), libsumo::Person::handleVariable(), libsumo::Lane::handleVariable(), libsumo::VehicleType::handleVariable(), libsumo::Simulation::handleVariable(), and libsumo::Vehicle::handleVariable().

◆ wrapPosition()

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

Implemented in libsumo::Helper::SubscriptionWrapper, and TraCIServer.

Referenced by libsumo::Junction::handleVariable(), libsumo::POI::handleVariable(), libsumo::Person::handleVariable(), and libsumo::Vehicle::handleVariable().

◆ wrapRoadPosition()

virtual bool libsumo::VariableWrapper::wrapRoadPosition ( const std::string &  objID,
const int  variable,
const TraCIRoadPosition &  value 
)
pure virtual

Implemented in libsumo::Helper::SubscriptionWrapper, and TraCIServer.

Referenced by libsumo::Vehicle::handleVariable().

◆ wrapString()

virtual bool libsumo::VariableWrapper::wrapString ( const std::string &  objID,
const int  variable,
const std::string &  value 
)
pure virtual

Implemented in TraCIServer, and libsumo::Helper::SubscriptionWrapper.

Referenced by libsumo::LaneArea::handleVariable(), libsumo::InductionLoop::handleVariable(), libsumo::TrafficLight::handleVariable(), libsumo::Polygon::handleVariable(), libsumo::POI::handleVariable(), libsumo::Edge::handleVariable(), libsumo::Person::handleVariable(), libsumo::Lane::handleVariable(), libsumo::VehicleType::handleVariable(), and libsumo::Vehicle::handleVariable().

◆ wrapStringList()

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

Implemented in TraCIServer, and libsumo::Helper::SubscriptionWrapper.

Referenced by libsumo::MultiEntryExit::handleVariable(), libsumo::LaneArea::handleVariable(), libsumo::Route::handleVariable(), libsumo::Junction::handleVariable(), libsumo::InductionLoop::handleVariable(), libsumo::TrafficLight::handleVariable(), libsumo::Polygon::handleVariable(), libsumo::POI::handleVariable(), libsumo::Edge::handleVariable(), libsumo::Person::handleVariable(), libsumo::Lane::handleVariable(), libsumo::VehicleType::handleVariable(), libsumo::Simulation::handleVariable(), and libsumo::Vehicle::handleVariable().

Field Documentation

◆ handle

SubscriptionHandler libsumo::VariableWrapper::handle

Definition at line 137 of file Subscription.h.

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