herald  2.0.0
Public Member Functions | List of all members
herald::engine::CoordinationProvider Class Referenceabstract

Coordination management class that arranges Sensor's periodic requirements and activity interdependencies. More...

#include <activities.h>

Inheritance diagram for herald::engine::CoordinationProvider:
herald::ble::HeraldProtocolBLECoordinationProvider< ContextT, herald::ble::ConcreteBLEDatabase< ContextT, 10 >, herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, herald::ble::ConcreteBLEDatabase< ContextT, 10 >, SensorDelegateSetT > > herald::ble::HeraldProtocolBLECoordinationProvider< ContextT, BLEDBT, ProviderT >

Public Member Functions

virtual std::vector< FeatureTagconnectionsProvided ()=0
 What connections does this Sensor type provide for Coordination.
 
virtual std::vector< PrioritisedPrerequisiteprovision (const std::vector< PrioritisedPrerequisite > &requested)=0
 Runtime connection provisioning (if it isn't requested, it can be closed) More...
 
virtual std::vector< PrioritisedPrerequisiterequiredConnections ()=0
 Get a list of what connections are required to which devices now (may start, maintain, end (if not included))
 
virtual std::vector< ActivityrequiredActivities ()=0
 Get a list of activities that are currently outstanding in this iteration.
 

Detailed Description

Coordination management class that arranges Sensor's periodic requirements and activity interdependencies.

Some sensors may have dependencies on others, or system features. This class provides a way of Sensors to let the Herald system know of their requirements and capabilities at any given moment.

Member Function Documentation

◆ provision()

virtual std::vector<PrioritisedPrerequisite> herald::engine::CoordinationProvider::provision ( const std::vector< PrioritisedPrerequisite > &  requested)
pure virtual

Runtime connection provisioning (if it isn't requested, it can be closed)

Note: WITH STD::SYNC ONLY: virtual void provision(const std::vector<PrioritisedPrerequisite>& requested, const ConnectionCallback& connCallback) = 0;

Implemented in herald::ble::HeraldProtocolBLECoordinationProvider< ContextT, BLEDBT, ProviderT >, and herald::ble::HeraldProtocolBLECoordinationProvider< ContextT, herald::ble::ConcreteBLEDatabase< ContextT, 10 >, herald::ble::ConcreteBLEReceiver< ContextT, PayloadDataSupplierT, herald::ble::ConcreteBLEDatabase< ContextT, 10 >, SensorDelegateSetT > >.


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