WSF
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
WsfXIO_SensorService Class Reference

#include <WsfXIO_SensorService.hpp>

Inheritance diagram for WsfXIO_SensorService:
Inheritance graph
[legend]
Collaboration diagram for WsfXIO_SensorService:
Collaboration graph
[legend]

Public Types

typedef WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService > BaseClassType
Public Types inherited from WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService >
using RequestType

Public Member Functions

 WsfXIO_SensorService (WsfXIO_Simulation &aXIO_Simulation)
Public Member Functions inherited from WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService >
 WsfXIO_ServiceT (WsfXIO_Interface *aInterfacePtr)
WsfXIO_Subscription * CreateSubscription (RequestType &aRequest)
 Create a subscription from a request.
Public Member Functions inherited from WsfXIO_SimService
 WsfXIO_SimService (WsfXIO_Interface *aInterfacePtr)
void Initialize (WsfSimulation &aSimulation)
void AddRequiredPlatform (WsfPlatform &aPlatform, WsfXIO_Subscription *aSubscriptionPtr)
 Adds a platform dependency on a subscription. If the platform is destroyed, the subscription is canceled.
Public Member Functions inherited from WsfXIO_Service
 WsfXIO_Service (WsfXIO_Interface *aInterfacePtr)
virtual ~WsfXIO_Service ()
WsfXIO_Subscription * FindSubscription (WsfXIO_Connection *aConnectionPtr, int aSubscriptionId)
WsfXIO_Interface * GetInterface () const

Protected Types

typedef std::multimap< WsfSensor *, WsfXIO_Subscription * > SensorToRequestMap
Protected Types inherited from WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService >
using RequestMapT
Protected Types inherited from WsfXIO_Service
using SubscriptionMap = std::map<WsfXIO_SubscriptionId, WsfXIO_Subscription*>

Protected Member Functions

void RequireCallbacks (bool aRequired)
void SubscriptionCancelledT (WsfXIO_Subscription *aSubscriptionPtr, WsfXIO_RequestSensorDataPkt &aRequestPkt) override
void HandleRequest (WsfXIO_RequestSensorDataPkt &aPkt)
void RequestCanceled (double aSimTime, WsfSensor *aSensorPtr, const WsfTrack *aTrackPtr)
void RequestUpdated (double aSimTime, WsfSensor *aSensorPtr, WsfSensorMode *aModePtr, const WsfTrack *aTrackPtr)
void SensorTurnedOff (double aSimTime, WsfSensor *aSenosrPtr)
Protected Member Functions inherited from WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService >
void SubscriptionCancelled (WsfXIO_Subscription *aSubscriptionPtr) override
const WsfXIO_RequestSensorDataPkt * FindRequest (WsfXIO_SubscriptionId aId) const
const RequestMapT & GetRequests () const
Protected Member Functions inherited from WsfXIO_SimService
void RemovingSubscription (WsfXIO_Subscription *aSubscriptionPtr) override
Protected Member Functions inherited from WsfXIO_Service
void DenyRequest (WsfXIO_RequestDataPkt &aRequest)
void HandleDisconnect (WsfXIO_Connection *aConnection)
void AddSubscription (WsfXIO_Subscription *aSubscriptionPtr)
bool RemoveSubscription (WsfXIO_Subscription *aSubscriptionPtr)
WsfXIO_Subscription * CreateSubscription (WsfXIO_RequestDataPkt &aRequest)
void HandleCancellation (WsfXIO_SubscriptionCancelPkt &aPkt)
const SubscriptionMap GetSubscriptions () const
WsfXIO_Subscription * FindSubscription (const WsfXIO_SubscriptionId &aSubscriptionId)

Protected Attributes

WsfSimulation & mSimulation
UtCallbackHolder mRequestCallbacks
int mRequestCount
 The number of requests for sensor request data.
SensorToRequestMap mSensorToRequests
Protected Attributes inherited from WsfXIO_Service
UtCallbackHolder mCallbacks
WsfXIO_Interface * mInterfacePtr

Detailed Description

Provides extended information about WSF sensors:

  • Tracking Requests

Member Typedef Documentation

◆ BaseClassType

typedef WsfXIO_ServiceT<WsfXIO_RequestSensorDataPkt, WsfXIO_SimService> WsfXIO_SensorService::BaseClassType

◆ SensorToRequestMap

typedef std::multimap<WsfSensor*, WsfXIO_Subscription*> WsfXIO_SensorService::SensorToRequestMap
protected

Constructor & Destructor Documentation

◆ WsfXIO_SensorService()

WsfXIO_SensorService::WsfXIO_SensorService ( WsfXIO_Simulation & aXIO_Simulation)

References WsfXIO_Service::GetInterface(), WsfXIO_Simulation::GetSimulation(), HandleRequest(), WsfXIO_SimService::Initialize(), WsfXIO_Service::mCallbacks, mRequestCount, and mSimulation.

Member Function Documentation

◆ HandleRequest()

void WsfXIO_SensorService::HandleRequest ( WsfXIO_RequestSensorDataPkt & aPkt)
protected

References WsfXIO_SimService::AddRequiredPlatform(), WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService >::CreateSubscription(), WsfXIO_RequestSensorDataPkt::cTRACKING_REQUESTS, WsfXIO_Service::DenyRequest(), WsfObject::GetNameId(), WsfDefaultSensorScheduler::GetRequestList(), WsfSensor::GetScheduler(), WsfXIO_SensorTrackingRequestUpdatePkt::mAddedRequests, WsfXIO_SensorTrackingRequestUpdatePkt::mClear, WsfXIO_SensorTrackingRequestUpdatePkt::TrackingRequest::mModeIndex, WsfXIO_RequestSensorDataPkt::mPlatformIndex, WsfXIO_SensorTrackingRequestUpdatePkt::mPlatformIndex, mRequestCount, WsfXIO_RequestSensorDataPkt::mRequiredData, WsfXIO_RequestSensorDataPkt::mSensorNameId, WsfXIO_SensorTrackingRequestUpdatePkt::mSensorNameId, mSensorToRequests, mSimulation, WsfXIO_SensorTrackingRequestUpdatePkt::TrackingRequest::mTrackId, platformPtr, RequireCallbacks(), and WsfXIO_Subscription::SendResponse().

Referenced by WsfXIO_SensorService().

◆ RequestCanceled()

void WsfXIO_SensorService::RequestCanceled ( double aSimTime,
WsfSensor * aSensorPtr,
const WsfTrack * aTrackPtr )
protected

References WsfXIO_RequestSensorDataPkt::cTRACKING_REQUESTS, WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService >::FindRequest(), WsfXIO_Subscription::GetId(), WsfTrack::GetTrackId(), WsfXIO_SensorTrackingRequestUpdatePkt::mClear, WsfXIO_RequestSensorDataPkt::mPlatformIndex, WsfXIO_SensorTrackingRequestUpdatePkt::mPlatformIndex, WsfXIO_SensorTrackingRequestUpdatePkt::mRemovedRequests, WsfXIO_RequestSensorDataPkt::mRequiredData, WsfXIO_RequestSensorDataPkt::mSensorNameId, WsfXIO_SensorTrackingRequestUpdatePkt::mSensorNameId, mSensorToRequests, and WsfXIO_Subscription::SendResponse().

Referenced by RequireCallbacks().

◆ RequestUpdated()

void WsfXIO_SensorService::RequestUpdated ( double aSimTime,
WsfSensor * aSensorPtr,
WsfSensorMode * aModePtr,
const WsfTrack * aTrackPtr )
protected

References WsfXIO_RequestSensorDataPkt::cTRACKING_REQUESTS, WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService >::FindRequest(), WsfXIO_Subscription::GetId(), WsfMode::GetModeIndex(), WsfTrack::GetTrackId(), WsfXIO_SensorTrackingRequestUpdatePkt::mAddedRequests, WsfXIO_SensorTrackingRequestUpdatePkt::mClear, WsfXIO_SensorTrackingRequestUpdatePkt::TrackingRequest::mModeIndex, WsfXIO_RequestSensorDataPkt::mPlatformIndex, WsfXIO_SensorTrackingRequestUpdatePkt::mPlatformIndex, WsfXIO_RequestSensorDataPkt::mRequiredData, WsfXIO_RequestSensorDataPkt::mSensorNameId, WsfXIO_SensorTrackingRequestUpdatePkt::mSensorNameId, mSensorToRequests, WsfXIO_SensorTrackingRequestUpdatePkt::TrackingRequest::mTrackId, and WsfXIO_Subscription::SendResponse().

Referenced by RequireCallbacks().

◆ RequireCallbacks()

void WsfXIO_SensorService::RequireCallbacks ( bool aRequired)
protected

References mRequestCallbacks, mSimulation, RequestCanceled(), RequestUpdated(), WsfObserver::SensorRequestCanceled(), WsfObserver::SensorRequestInitiated(), WsfObserver::SensorRequestUpdated(), WsfObserver::SensorTurnedOff(), and SensorTurnedOff().

Referenced by HandleRequest(), and SubscriptionCancelledT().

◆ SensorTurnedOff()

void WsfXIO_SensorService::SensorTurnedOff ( double aSimTime,
WsfSensor * aSenosrPtr )
protected

References WsfXIO_RequestSensorDataPkt::cTRACKING_REQUESTS, WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService >::FindRequest(), WsfXIO_Subscription::GetId(), WsfXIO_SensorTrackingRequestUpdatePkt::mClear, WsfXIO_RequestSensorDataPkt::mPlatformIndex, WsfXIO_SensorTrackingRequestUpdatePkt::mPlatformIndex, WsfXIO_RequestSensorDataPkt::mRequiredData, WsfXIO_RequestSensorDataPkt::mSensorNameId, WsfXIO_SensorTrackingRequestUpdatePkt::mSensorNameId, mSensorToRequests, and WsfXIO_Subscription::SendResponse().

Referenced by RequireCallbacks().

◆ SubscriptionCancelledT()

void WsfXIO_SensorService::SubscriptionCancelledT ( WsfXIO_Subscription * aSubscriptionPtr,
WsfXIO_RequestSensorDataPkt & aRequest )
overrideprotectedvirtual

Called when a subscription has been canceled May be called due to lost connection, destroyed simulation entity, or cancellation request

Reimplemented from WsfXIO_ServiceT< WsfXIO_RequestSensorDataPkt, WsfXIO_SimService >.

References WsfXIO_RequestSensorDataPkt::cTRACKING_REQUESTS, mRequestCount, WsfXIO_RequestSensorDataPkt::mRequiredData, mSensorToRequests, and RequireCallbacks().

Member Data Documentation

◆ mRequestCallbacks

UtCallbackHolder WsfXIO_SensorService::mRequestCallbacks
protected

Referenced by RequireCallbacks().

◆ mRequestCount

int WsfXIO_SensorService::mRequestCount
protected

The number of requests for sensor request data.

Referenced by HandleRequest(), SubscriptionCancelledT(), and WsfXIO_SensorService().

◆ mSensorToRequests

SensorToRequestMap WsfXIO_SensorService::mSensorToRequests
protected

Referenced by HandleRequest(), RequestCanceled(), RequestUpdated(), SensorTurnedOff(), and SubscriptionCancelledT().

◆ mSimulation

WsfSimulation& WsfXIO_SensorService::mSimulation
protected

Referenced by HandleRequest(), RequireCallbacks(), and WsfXIO_SensorService().

The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved