Eclipse SUMO - Simulation of Urban MObility
libsumo::Subscription Class Reference

Representation of a subscription. More...

#include <Subscription.h>

Public Member Functions

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

Data Fields

int activeFilters
 Active filters for the subscription (bitset,. More...
 
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...
 
SUMOTime endTime
 The end time of the subscription. More...
 
double filterDownstreamDist
 Downstream distance specified by the downstream distance filter. More...
 
double filterFieldOfVisionOpeningAngle
 Opening angle (in deg) specified by the field of vision filter. More...
 
std::vector< int > filterLanes
 lanes specified by the lanes filter More...
 
double filterLateralDist
 Lateral distance specified by the lateral distance filter. More...
 
double filterUpstreamDist
 Upstream distance specified by the upstream distance filter. More...
 
int filterVClasses
 vClasses specified by the vClasses filter, More...
 
std::set< std::string > filterVTypes
 vTypes specified by the vTypes filter 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 67 of file Subscription.h.

Constructor & Destructor Documentation

◆ Subscription()

libsumo::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,
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]paramsArgThe parameters for the subscribed variables
[in]beginTimeArgThe begin time of the subscription
[in]endTimeArgThe end time of the subscription
[in]contextDomainArgThe domain ID of the context
[in]rangeArgThe range of the context

Definition at line 79 of file Subscription.h.

Member Function Documentation

◆ isVehicleToPersonContextSubscription()

bool libsumo::Subscription::isVehicleToPersonContextSubscription ( ) const
inline

Definition at line 105 of file Subscription.h.

References libsumo::CMD_GET_PERSON_VARIABLE, libsumo::CMD_SUBSCRIBE_VEHICLE_CONTEXT, commandId, and contextDomain.

Referenced by libsumo::Helper::applySubscriptionFilterFieldOfVision(), TraCIServer::initialiseSubscription(), and libsumo::Helper::subscribe().

Here is the caller graph for this function:

◆ isVehicleToVehicleContextSubscription()

bool libsumo::Subscription::isVehicleToVehicleContextSubscription ( ) const
inline

Definition at line 101 of file Subscription.h.

References libsumo::CMD_GET_VEHICLE_VARIABLE, libsumo::CMD_SUBSCRIBE_VEHICLE_CONTEXT, commandId, and contextDomain.

Referenced by TraCIServer::initialiseSubscription(), and libsumo::Helper::subscribe().

Here is the caller graph for this function:

Field Documentation

◆ activeFilters

◆ beginTime

SUMOTime libsumo::Subscription::beginTime

The begin time of the subscription.

Definition at line 118 of file Subscription.h.

Referenced by TraCIServer::initialiseSubscription(), libsumo::Helper::needNewSubscription(), and TraCIServer::postProcessSimulationStep().

◆ commandId

◆ contextDomain

◆ endTime

SUMOTime libsumo::Subscription::endTime

◆ filterDownstreamDist

double libsumo::Subscription::filterDownstreamDist

◆ filterFieldOfVisionOpeningAngle

double libsumo::Subscription::filterFieldOfVisionOpeningAngle

Opening angle (in deg) specified by the field of vision filter.

Definition at line 139 of file Subscription.h.

Referenced by TraCIServer::addSubscriptionFilterFieldOfVision(), and libsumo::Helper::applySubscriptionFilterFieldOfVision().

◆ filterLanes

std::vector<int> libsumo::Subscription::filterLanes

lanes specified by the lanes filter

Definition at line 129 of file Subscription.h.

Referenced by TraCIServer::addSubscriptionFilterLanes(), and libsumo::Helper::applySubscriptionFilters().

◆ filterLateralDist

double libsumo::Subscription::filterLateralDist

◆ filterUpstreamDist

double libsumo::Subscription::filterUpstreamDist

◆ filterVClasses

int libsumo::Subscription::filterVClasses

vClasses specified by the vClasses filter,

See also
SVCPermissions

Definition at line 137 of file Subscription.h.

Referenced by TraCIServer::addSubscriptionFilterVClass(), and libsumo::Helper::applySubscriptionFilters().

◆ filterVTypes

std::set<std::string> libsumo::Subscription::filterVTypes

vTypes specified by the vTypes filter

Definition at line 135 of file Subscription.h.

Referenced by TraCIServer::addSubscriptionFilterVType(), and libsumo::Helper::applySubscriptionFilters().

◆ id

◆ parameters

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

The parameters for the subscribed variables.

Definition at line 116 of file Subscription.h.

Referenced by libsumo::Helper::handleSingleSubscription(), libsumo::Helper::needNewSubscription(), and TraCIServer::processSingleSubscription().

◆ range

◆ variables

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

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