Eclipse SUMO - Simulation of Urban MObility
libsumo::Helper::SubscriptionWrapper Class Referencefinal

#include <Helper.h>

Inheritance diagram for libsumo::Helper::SubscriptionWrapper:
[legend]
Collaboration diagram for libsumo::Helper::SubscriptionWrapper:
[legend]

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

void clear ()
 
const std::vector< unsigned char > * getParams () const
 
void setContext (const std::string &refID)
 
void setParams (const std::vector< unsigned char > *params)
 
 SubscriptionWrapper (VariableWrapper::SubscriptionHandler handler, SubscriptionResults &into, ContextSubscriptionResults &context)
 
bool wrapColor (const std::string &objID, const int variable, const TraCIColor &value)
 
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 wrapPosition (const std::string &objID, const int variable, const TraCIPosition &value)
 
bool wrapRoadPosition (const std::string &objID, const int variable, const TraCIRoadPosition &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)
 

Data Fields

SubscriptionHandler handle
 

Private Member Functions

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

Private Attributes

SubscriptionResultsmyActiveResults
 
ContextSubscriptionResultsmyContextResults
 
const std::vector< unsigned char > * myParams = nullptr
 
SubscriptionResultsmyResults
 

Detailed Description

Definition at line 216 of file Helper.h.

Member Typedef Documentation

◆ SubscriptionHandler

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

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

Definition at line 147 of file Subscription.h.

Constructor & Destructor Documentation

◆ SubscriptionWrapper()

libsumo::Helper::SubscriptionWrapper::SubscriptionWrapper ( VariableWrapper::SubscriptionHandler  handler,
SubscriptionResults into,
ContextSubscriptionResults context 
)

Definition at line 1523 of file Helper.cpp.

Member Function Documentation

◆ clear()

void libsumo::Helper::SubscriptionWrapper::clear ( )
virtual

Reimplemented from libsumo::VariableWrapper.

Definition at line 1542 of file Helper.cpp.

◆ getParams()

const std::vector<unsigned char>* libsumo::Helper::SubscriptionWrapper::getParams ( ) const
inlinevirtual

Reimplemented from libsumo::VariableWrapper.

Definition at line 221 of file Helper.h.

References myParams.

◆ operator=()

SubscriptionWrapper& libsumo::Helper::SubscriptionWrapper::operator= ( const SubscriptionWrapper s)
privatedelete

Invalidated assignment operator.

◆ setContext()

void libsumo::Helper::SubscriptionWrapper::setContext ( const std::string &  refID)
virtual

Reimplemented from libsumo::VariableWrapper.

Definition at line 1530 of file Helper.cpp.

◆ setParams()

void libsumo::Helper::SubscriptionWrapper::setParams ( const std::vector< unsigned char > *  params)
virtual

Reimplemented from libsumo::VariableWrapper.

Definition at line 1536 of file Helper.cpp.

◆ wrapColor()

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

Implements libsumo::VariableWrapper.

Definition at line 1587 of file Helper.cpp.

◆ wrapDouble()

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

Implements libsumo::VariableWrapper.

Definition at line 1550 of file Helper.cpp.

◆ wrapInt()

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

Implements libsumo::VariableWrapper.

Definition at line 1557 of file Helper.cpp.

◆ wrapPosition()

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

Implements libsumo::VariableWrapper.

Definition at line 1580 of file Helper.cpp.

◆ wrapRoadPosition()

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

Implements libsumo::VariableWrapper.

Definition at line 1594 of file Helper.cpp.

◆ wrapString()

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

Implements libsumo::VariableWrapper.

Definition at line 1564 of file Helper.cpp.

◆ wrapStringList()

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

Implements libsumo::VariableWrapper.

Definition at line 1571 of file Helper.cpp.

Field Documentation

◆ handle

SubscriptionHandler libsumo::VariableWrapper::handle
inherited

Definition at line 149 of file Subscription.h.

◆ myActiveResults

SubscriptionResults* libsumo::Helper::SubscriptionWrapper::myActiveResults
private

Definition at line 235 of file Helper.h.

◆ myContextResults

ContextSubscriptionResults& libsumo::Helper::SubscriptionWrapper::myContextResults
private

Definition at line 234 of file Helper.h.

◆ myParams

const std::vector<unsigned char>* libsumo::Helper::SubscriptionWrapper::myParams = nullptr
private

Definition at line 236 of file Helper.h.

Referenced by getParams().

◆ myResults

SubscriptionResults& libsumo::Helper::SubscriptionWrapper::myResults
private

Definition at line 233 of file Helper.h.


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