TraCIServer::Subscription Class Reference

Representation of a subscription. More...

Collaboration diagram for TraCIServer::Subscription:

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 394 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]	commandIdArg	The command id of the subscription
[in]	idArg	The id of the object that is subscribed
[in]	variablesArg	The subscribed variables
[in]	beginTimeArg	The begin time of the subscription
[in]	endTimeArg	The end time of the subscription
[in]	contextVarsArg	Whether the subscription is a context subscription (variable subscription otherwise)
[in]	contextDomainArg	The domain ID of the context
[in]	rangeArg	The range of the context

Definition at line 406 of file TraCIServer.h.

Field Documentation

beginTime

SUMOTime TraCIServer::Subscription::beginTime

The begin time of the subscription.

Definition at line 421 of file TraCIServer.h.

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

commandId

int TraCIServer::Subscription::commandId

commandIdArg The command id of the subscription

Definition at line 413 of file TraCIServer.h.

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

contextDomain

int TraCIServer::Subscription::contextDomain

The domain ID of the context.

Definition at line 427 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 425 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 423 of file TraCIServer.h.

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

id

std::string TraCIServer::Subscription::id

The id of the object that is subscribed.

Definition at line 415 of file TraCIServer.h.

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

parameters

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

The parameters for the subscribed variables.

Definition at line 419 of file TraCIServer.h.

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

range

double TraCIServer::Subscription::range

The range of the context.

Definition at line 429 of file TraCIServer.h.

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

variables

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

The subscribed variables.

Definition at line 417 of file TraCIServer.h.

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

---

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

• TraCIServer.h