Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
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::shared_ptr< tcpip::Storage > > &paramsArg, SUMOTime beginTimeArg, SUMOTime endTimeArg, int contextDomainArg, double rangeArg)
 Constructor.

Data Fields

int activeFilters
 Active filters for the subscription (bitset,.
SUMOTime beginTime
 The begin time of the subscription.
int commandId
 commandIdArg The command id of the subscription
int contextDomain
 The domain ID of the context.
SUMOTime endTime
 The end time of the subscription.
double filterDownstreamDist
 Downstream distance specified by the downstream distance filter.
double filterFieldOfVisionOpeningAngle
 Opening angle (in deg) specified by the field of vision filter.
double filterFoeDistToJunction
 Foe distance to junction specified by the turn filter.
std::vector< int > filterLanes
 lanes specified by the lanes filter
double filterLateralDist
 Lateral distance specified by the lateral distance filter.
double filterUpstreamDist
 Upstream distance specified by the upstream distance filter.
SVCPermissions filterVClasses
 vClasses specified by the vClasses filter,
std::set< std::string > filterVTypes
 vTypes specified by the vTypes filter
std::string id
 The id of the object that is subscribed.
std::vector< std::shared_ptr< tcpip::Storage > > parameters
 The parameters for the subscribed variables.
double range
 The range of the context.
std::vector< int > variables
 The subscribed variables.

Detailed Description

Representation of a subscription.

Definition at line 70 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::shared_ptr< tcpip::Storage > > & 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 82 of file Subscription.h.

References activeFilters, beginTime, commandId, contextDomain, endTime, filterDownstreamDist, filterFieldOfVisionOpeningAngle, filterFoeDistToJunction, filterLanes, filterLateralDist, filterUpstreamDist, filterVClasses, filterVTypes, id, parameters, range, libsumo::SUBS_FILTER_NONE, and variables.

Member Function Documentation

◆ isVehicleToPersonContextSubscription()

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

Definition at line 109 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 105 of file Subscription.h.

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

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

Here is the caller graph for this function:

Field Documentation

◆ activeFilters

int libsumo::Subscription::activeFilters

Active filters for the subscription (bitset,.

See also
SubscriptionFilterType)

Definition at line 131 of file Subscription.h.

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

◆ beginTime

SUMOTime libsumo::Subscription::beginTime

The begin time of the subscription.

Definition at line 122 of file Subscription.h.

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

◆ commandId

int libsumo::Subscription::commandId

commandIdArg The command id of the subscription

Definition at line 114 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilterLateralDistance(), TraCIServer::centralObject(), libsumo::Helper::handleSingleSubscription(), libsumo::Helper::handleSubscriptions(), TraCIServer::initialiseSubscription(), isVehicleToPersonContextSubscription(), isVehicleToVehicleContextSubscription(), libsumo::Helper::needNewSubscription(), TraCIServer::postProcessSimulationStep(), TraCIServer::processSingleSubscription(), and Subscription().

◆ contextDomain

int libsumo::Subscription::contextDomain

The domain ID of the context.

Definition at line 126 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilterFieldOfVision(), libsumo::Helper::applySubscriptionFilterLanes(), libsumo::Helper::applySubscriptionFilterLateralDistance(), libsumo::Helper::applySubscriptionFilterLateralDistanceSinglePass(), libsumo::Helper::applySubscriptionFilterTurn(), TraCIServer::centralObject(), libsumo::Helper::handleSingleSubscription(), isVehicleToPersonContextSubscription(), isVehicleToVehicleContextSubscription(), libsumo::Helper::needNewSubscription(), TraCIServer::processSingleSubscription(), and Subscription().

◆ endTime

SUMOTime libsumo::Subscription::endTime

The end time of the subscription.

Definition at line 124 of file Subscription.h.

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

◆ filterDownstreamDist

double libsumo::Subscription::filterDownstreamDist

Downstream distance specified by the downstream distance filter.

Definition at line 135 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilterLateralDistanceSinglePass(), libsumo::Helper::applySubscriptionFilters(), libsumo::Helper::applySubscriptionFilterTurn(), and Subscription().

◆ filterFieldOfVisionOpeningAngle

double libsumo::Subscription::filterFieldOfVisionOpeningAngle

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

Definition at line 145 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilterFieldOfVision(), and Subscription().

◆ filterFoeDistToJunction

double libsumo::Subscription::filterFoeDistToJunction

Foe distance to junction specified by the turn filter.

Definition at line 139 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilterTurn(), and Subscription().

◆ filterLanes

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

lanes specified by the lanes filter

Definition at line 133 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilters(), and Subscription().

◆ filterLateralDist

double libsumo::Subscription::filterLateralDist

Lateral distance specified by the lateral distance filter.

Definition at line 147 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilterLateralDistanceSinglePass(), libsumo::Helper::applySubscriptionFilters(), and Subscription().

◆ filterUpstreamDist

double libsumo::Subscription::filterUpstreamDist

Upstream distance specified by the upstream distance filter.

Definition at line 137 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilterLateralDistanceSinglePass(), libsumo::Helper::applySubscriptionFilters(), and Subscription().

◆ filterVClasses

SVCPermissions libsumo::Subscription::filterVClasses

vClasses specified by the vClasses filter,

See also
SVCPermissions

Definition at line 143 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilters(), and Subscription().

◆ filterVTypes

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

vTypes specified by the vTypes filter

Definition at line 141 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilters(), and Subscription().

◆ id

std::string libsumo::Subscription::id

The id of the object that is subscribed.

Definition at line 116 of file Subscription.h.

Referenced by libsumo::Helper::applySubscriptionFilterFieldOfVision(), libsumo::Helper::applySubscriptionFilterLanes(), libsumo::Helper::applySubscriptionFilterLateralDistance(), libsumo::Helper::applySubscriptionFilters(), libsumo::Helper::applySubscriptionFilterTurn(), TraCIServer::centralObject(), libsumo::Helper::handleSingleSubscription(), libsumo::Helper::handleSubscriptions(), libsumo::Helper::needNewSubscription(), TraCIServer::postProcessSimulationStep(), TraCIServer::processSingleSubscription(), and Subscription().

◆ parameters

std::vector<std::shared_ptr<tcpip::Storage> > libsumo::Subscription::parameters

The parameters for the subscribed variables.

Definition at line 120 of file Subscription.h.

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

◆ range

double libsumo::Subscription::range

The range of the context.

Definition at line 128 of file Subscription.h.

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

◆ variables

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

The subscribed variables.

Definition at line 118 of file Subscription.h.

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

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