RTC Toolkit  2.0.0
Public Types | Public Member Functions | List of all members
rtctk::exampleDataTask::BusinessLogic Class Reference

#include <businessLogic.hpp>

Inheritance diagram for rtctk::exampleDataTask::BusinessLogic:
rtctk::componentFramework::Measurable< Super >::BizLogicIf

Public Types

using ComponentType = LifeCycle
 
using ComponentType = LifeCycle
 
using ComponentType = LifeCycle
 

Public Member Functions

 BusinessLogic (const std::string &name, ServiceContainer &services)
 
void ActivityInitialising (StopToken st) override
 
void ActivityEnabling (StopToken st) override
 
void ActivityDisabling (StopToken st) override
 
void ActivityUpdating (StopToken st, Payload args) override
 
JsonPayload ActivityMeasuring (StopToken st, JsonPayload const &arg) override
 Activity executed in its own thread that peforms the requested measurement specified by JSON argument. More...
 
 BusinessLogic (const std::string &name, ServiceContainer &services)
 
void ActivityInitialising (StopToken st) override
 
void ActivityUpdating (StopToken st, Payload arg) override
 
void ActivityOptimising (StopToken st, JsonPayload const &arg) override
 
 BusinessLogic (const std::string &name, ServiceContainer &services)
 
virtual ~BusinessLogic ()
 
void ActivityStarting (StopToken st) override
 
void ActivityInitialising (StopToken st) override
 
void ActivityEnabling (StopToken st) override
 
void ActivityDisabling (StopToken st) override
 
void ActivityGoingRunning (StopToken st) override
 
void ActivityGoingIdle (StopToken st) override
 
void ActivityRunning (StopToken st) override
 
void ActivityUpdating (StopToken st, Payload args) override
 
bool GuardUpdatingAllowed (Payload args) override
 
- Public Member Functions inherited from rtctk::componentFramework::Measurable< Super >::BizLogicIf
virtual bool GuardMeasuringAllowed (JsonPayload const &arg)
 Determines if measurement is possible at this time with the provided argument. More...
 

Member Typedef Documentation

◆ ComponentType [1/3]

◆ ComponentType [2/3]

◆ ComponentType [3/3]

Constructor & Destructor Documentation

◆ BusinessLogic() [1/3]

rtctk::exampleDataTask::BusinessLogic::BusinessLogic ( const std::string &  name,
ServiceContainer services 
)
inline

◆ BusinessLogic() [2/3]

rtctk::exampleDataTask::BusinessLogic::BusinessLogic ( const std::string &  name,
ServiceContainer services 
)
inline

◆ BusinessLogic() [3/3]

rtctk::exampleDataTask::BusinessLogic::BusinessLogic ( const std::string &  name,
ServiceContainer services 
)
inline

◆ ~BusinessLogic()

virtual rtctk::exampleDataTask::BusinessLogic::~BusinessLogic ( )
inlinevirtual

Member Function Documentation

◆ ActivityDisabling() [1/2]

void rtctk::exampleDataTask::BusinessLogic::ActivityDisabling ( StopToken  st)
inlineoverride

◆ ActivityDisabling() [2/2]

void rtctk::exampleDataTask::BusinessLogic::ActivityDisabling ( StopToken  st)
inlineoverride

◆ ActivityEnabling() [1/2]

void rtctk::exampleDataTask::BusinessLogic::ActivityEnabling ( StopToken  st)
inlineoverride

◆ ActivityEnabling() [2/2]

void rtctk::exampleDataTask::BusinessLogic::ActivityEnabling ( StopToken  st)
inlineoverride

◆ ActivityGoingIdle()

void rtctk::exampleDataTask::BusinessLogic::ActivityGoingIdle ( StopToken  st)
inlineoverride

◆ ActivityGoingRunning()

void rtctk::exampleDataTask::BusinessLogic::ActivityGoingRunning ( StopToken  st)
inlineoverride

◆ ActivityInitialising() [1/3]

void rtctk::exampleDataTask::BusinessLogic::ActivityInitialising ( StopToken  st)
inlineoverride

◆ ActivityInitialising() [2/3]

void rtctk::exampleDataTask::BusinessLogic::ActivityInitialising ( StopToken  st)
inlineoverride

◆ ActivityInitialising() [3/3]

void rtctk::exampleDataTask::BusinessLogic::ActivityInitialising ( StopToken  st)
inlineoverride

◆ ActivityMeasuring()

JsonPayload rtctk::exampleDataTask::BusinessLogic::ActivityMeasuring ( StopToken  stop_token,
JsonPayload const &  arg 
)
inlineoverridevirtual

Activity executed in its own thread that peforms the requested measurement specified by JSON argument.

Parameters
stop_tokenIndicates when activity is requested to stop.
argProvides arguments for measurement to be performed.
Returns
JSON measurement result.
Thread Safety
thread-safe – Method is invoked from unspecified thread and must be thread safe.
Exception Safety
basic – Method may throw exception. The exception message will returned to requestor.

Reimplemented from rtctk::componentFramework::Measurable< Super >::BizLogicIf.

◆ ActivityOptimising()

void rtctk::exampleDataTask::BusinessLogic::ActivityOptimising ( StopToken  st,
JsonPayload const &  arg 
)
inlineoverride

◆ ActivityRunning()

void rtctk::exampleDataTask::BusinessLogic::ActivityRunning ( StopToken  st)
inlineoverride

◆ ActivityStarting()

void rtctk::exampleDataTask::BusinessLogic::ActivityStarting ( StopToken  st)
inlineoverride

◆ ActivityUpdating() [1/3]

void rtctk::exampleDataTask::BusinessLogic::ActivityUpdating ( StopToken  st,
Payload  arg 
)
inlineoverride

◆ ActivityUpdating() [2/3]

void rtctk::exampleDataTask::BusinessLogic::ActivityUpdating ( StopToken  st,
Payload  args 
)
inlineoverride

◆ ActivityUpdating() [3/3]

void rtctk::exampleDataTask::BusinessLogic::ActivityUpdating ( StopToken  st,
Payload  args 
)
inlineoverride

◆ GuardUpdatingAllowed()

bool rtctk::exampleDataTask::BusinessLogic::GuardUpdatingAllowed ( Payload  args)
inlineoverride

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