rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf Class Reference

Business logic interface for Supervisory mixin. More...

#include <rtctk/rtcSupervisor/supervisory.hpp>

Inheritance diagram for rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf:

Public Member Functions
virtual std::string	ActionGetStatus ()
virtual void	ActivitySettingModes (StopToken st, const JsonPayload &arg)
virtual bool	GuardSettingModesAllowed (const JsonPayload &arg)
	Determines if set mode is possible at this time with the provided argument.
virtual void	ActionSetDeferredModes (const JsonPayload &arg)
virtual JsonPayload	ActionGetAvailableModes ()
virtual JsonPayload	ActionGetActiveModes ()
virtual JsonPayload	ActionGetDeferredModes ()
virtual void	ActivityWritingBack (StopToken st, const JsonPayload &arg)
virtual bool	GuardWritingBackAllowed (const JsonPayload &arg)
virtual void	ActivityRecovering (StopToken st)

Detailed Description

template<typename Super>
class rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf

Business logic interface for Supervisory mixin.

Member Function Documentation

ActionGetActiveModes()

template<typename Super>

virtual JsonPayload rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf::ActionGetActiveModes ( )

inlinevirtual

      Action is used for mode inspection and executed in the state machine thread.

      \par Thread Safety
 \parblock \ref thread-safety "thread-safe" --  Method is invoked from unspecified thread and must be thread safe. \endparblock
      \par Exception Safety
 \parblock \ref exception-safety "basic" --  Method may throw an exception. The exception message will be returned to

the requestor.

ActionGetAvailableModes()

template<typename Super>

virtual JsonPayload rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf::ActionGetAvailableModes ( )

inlinevirtual

      Action is used for mode inspection and executed in the state machine thread.

      \par Thread Safety
 \parblock \ref thread-safety "thread-safe" --  Method is invoked from unspecified thread and must be thread safe. \endparblock
      \par Exception Safety
 \parblock \ref exception-safety "basic" --  Method may throw an exception. The exception message will be returned to

the requestor.

ActionGetDeferredModes()

template<typename Super>

virtual JsonPayload rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf::ActionGetDeferredModes ( )

inlinevirtual

      Action is used for mode inspection and executed in the state machine thread.

      \par Thread Safety
 \parblock \ref thread-safety "thread-safe" --  Method is invoked from unspecified thread and must be thread safe. \endparblock
      \par Exception Safety
 \parblock \ref exception-safety "basic" --  Method may throw an exception. The exception message will be returned to

the requestor.

ActionGetStatus()

template<typename Super>

virtual std::string rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf::ActionGetStatus ( )

inlinevirtual

      Action is used for system status inspection and is executed in the state machine thread.

      \par Thread Safety
 \parblock \ref thread-safety "thread-safe" --  Method is invoked from unspecified thread and must be thread safe. \endparblock
      \par Exception Safety
 \parblock \ref exception-safety "basic" --  Method may throw an exception. The exception message will be returned to

the requestor.

ActionSetDeferredModes()

template<typename Super>

virtual void rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf::ActionSetDeferredModes ( const JsonPayload & arg )

inlinevirtual

      Action is executed in the state machine thread and it performs deferred mode setting.

      @param arg Provides arguments for the mode setting to be performed.

      \par Thread Safety
 \parblock \ref thread-safety "thread-safe" --  Method is invoked from unspecified thread and must be thread safe. \endparblock
      \par Exception Safety
 \parblock \ref exception-safety "basic" --  Method may throw an exception. The exception message will be returned to

the requestor.

ActivityRecovering()

template<typename Super>

virtual void rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf::ActivityRecovering ( StopToken st )

inlinevirtual

      Activity executed in its own thread that performs the error recovery.

      @param st Indicates when activity is requested to stop.

      \par Thread Safety
 \parblock \ref thread-safety "thread-safe" --  Method is invoked from unspecified thread and must be thread safe. \endparblock
      \par Exception Safety
 \parblock \ref exception-safety "basic" --  Method may throw an exception. The exception message will be returned to

the requestor.

ActivitySettingModes()

template<typename Super>

virtual void rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf::ActivitySettingModes ( StopToken st, const JsonPayload & arg )

inlinevirtual

      Activity executed in its own thread that performs the mode setting.

      @param st Indicates when activity is requested to stop.
      @param arg Provides arguments for the mode setting to be performed.

      \par Thread Safety
 \parblock \ref thread-safety "thread-safe" --  Method is invoked from an unspecified thread and must be thread safe. \endparblock
      \par Exception Safety
 \parblock \ref exception-safety "basic" --  Method may throw an exception. The exception message will be returned to

the requestor.

ActivityWritingBack()

template<typename Super>

virtual void rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf::ActivityWritingBack ( StopToken st, const JsonPayload & arg )

inlinevirtual

      Activity executed in its own thread that performs the writeback.

      @param st Indicates when activity is requested to stop.
      @param arg Provides arguments for the mode setting to be performed.

      \par Thread Safety
 \parblock \ref thread-safety "thread-safe" --  Method is invoked from unspecified thread and must be thread safe. \endparblock
      \par Exception Safety
 \parblock \ref exception-safety "basic" --  Method may throw an exception. The exception message will be returned to

the requestor.

GuardSettingModesAllowed()

template<typename Super>

virtual bool rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf::GuardSettingModesAllowed ( const JsonPayload & arg )

inlinevirtual

Determines if set mode is possible at this time with the provided argument.

Parameters

arg	Provided argument.

Returns

true if allowed.

false if disallowed. This results in the command being rejected.

Exception Safety

basic – Method may throw, which will result in SetModes request being rejected.

GuardWritingBackAllowed()

template<typename Super>

virtual bool rtctk::rtcSupervisor::Supervisory< Super >::BizLogicIf::GuardWritingBackAllowed ( const JsonPayload & arg )

inlinevirtual

      Determines if writeback is possible at this time with the provided argument.

      @param arg Provided argument.
      @return true if allowed.
      @return false if disallowed. This results in the command being rejected.

      \par Exception Safety
 \parblock \ref exception-safety "basic" --  Method may throw, which will result in WriteBack request being

rejected.

---

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

• reusableComponents/rtcSupervisor/lib/src/include/rtctk/rtcSupervisor/supervisory.hpp