SUMO - Simulation of Urban MObility
TraCIServer::Subscription Class Reference

Representation of a subscription. More...

Collaboration diagram for TraCIServer::Subscription:
Collaboration graph

Public Member Functions

 Subscription (int commandIdArg, const std::string &idArg, const std::vector< int > &variablesArg, const std::vector< std::vector< unsigned char > > &paramsArg, SUMOTime beginTimeArg, SUMOTime endTimeArg, bool contextVarsArg, int contextDomainArg, double rangeArg)
 Constructor. More...
 

Data Fields

SUMOTime beginTime
 The begin time of the subscription. More...
 
int commandId
 commandIdArg The command id of the subscription More...
 
int contextDomain
 The domain ID of the context. More...
 
bool contextVars
 Whether the subscription is a context subscription (variable subscription otherwise) More...
 
SUMOTime endTime
 The end time of the subscription. More...
 
std::string id
 The id of the object that is subscribed. More...
 
std::vector< std::vector< unsigned char > > parameters
 The parameters for the subscribed variables. More...
 
double range
 The range of the context. More...
 
std::vector< int > variables
 The subscribed variables. More...
 

Detailed Description

Representation of a subscription.

Definition at line 333 of file TraCIServer.h.

Constructor & Destructor Documentation

◆ Subscription()

TraCIServer::Subscription::Subscription ( int  commandIdArg,
const std::string &  idArg,
const std::vector< int > &  variablesArg,
const std::vector< std::vector< unsigned char > > &  paramsArg,
SUMOTime  beginTimeArg,
SUMOTime  endTimeArg,
bool  contextVarsArg,
int  contextDomainArg,
double  rangeArg 
)
inline

Constructor.

Parameters
[in]commandIdArgThe command id of the subscription
[in]idArgThe id of the object that is subscribed
[in]variablesArgThe subscribed variables
[in]beginTimeArgThe begin time of the subscription
[in]endTimeArgThe end time of the subscription
[in]contextVarsArgWhether the subscription is a context subscription (variable subscription otherwise)
[in]contextDomainArgThe domain ID of the context
[in]rangeArgThe range of the context

Definition at line 345 of file TraCIServer.h.

Field Documentation

◆ beginTime

SUMOTime TraCIServer::Subscription::beginTime

The begin time of the subscription.

Definition at line 360 of file TraCIServer.h.

Referenced by TraCIServer::initialiseSubscription(), and TraCIServer::postProcessSimulationStep2().

◆ commandId

int TraCIServer::Subscription::commandId

commandIdArg The command id of the subscription

Definition at line 352 of file TraCIServer.h.

Referenced by TraCIServer::initialiseSubscription(), TraCIServer::postProcessSimulationStep2(), and TraCIServer::processSingleSubscription().

◆ contextDomain

int TraCIServer::Subscription::contextDomain

The domain ID of the context.

Definition at line 366 of file TraCIServer.h.

Referenced by TraCIServer::initialiseSubscription(), and TraCIServer::processSingleSubscription().

◆ contextVars

bool TraCIServer::Subscription::contextVars

Whether the subscription is a context subscription (variable subscription otherwise)

Definition at line 364 of file TraCIServer.h.

Referenced by TraCIServer::initialiseSubscription(), and TraCIServer::processSingleSubscription().

◆ endTime

SUMOTime TraCIServer::Subscription::endTime

The end time of the subscription.

Definition at line 362 of file TraCIServer.h.

Referenced by TraCIServer::initialiseSubscription(), and TraCIServer::postProcessSimulationStep2().

◆ id

std::string TraCIServer::Subscription::id

The id of the object that is subscribed.

Definition at line 354 of file TraCIServer.h.

Referenced by TraCIServer::initialiseSubscription(), TraCIServer::postProcessSimulationStep2(), and TraCIServer::processSingleSubscription().

◆ parameters

std::vector<std::vector<unsigned char> > TraCIServer::Subscription::parameters

The parameters for the subscribed variables.

Definition at line 358 of file TraCIServer.h.

Referenced by TraCIServer::initialiseSubscription(), and TraCIServer::processSingleSubscription().

◆ range

double TraCIServer::Subscription::range

The range of the context.

Definition at line 368 of file TraCIServer.h.

Referenced by TraCIServer::initialiseSubscription(), and TraCIServer::processSingleSubscription().

◆ variables

std::vector<int> TraCIServer::Subscription::variables

The subscribed variables.

Definition at line 356 of file TraCIServer.h.

Referenced by TraCIServer::initialiseSubscription(), and TraCIServer::processSingleSubscription().


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