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 ()
	Action is used for system status inspection and is executed in the state machine thread.
virtual void	ActivitySettingModes (StopToken st, const JsonPayload &arg)
	Activity executed in its own thread that performs the mode setting.
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)
	Action is executed in the state machine thread and it performs deferred mode setting.
virtual JsonPayload	ActionGetAvailableModes ()
	Action is used for mode inspection and executed in the state machine thread.
virtual JsonPayload	ActionGetActiveModes ()
	Action is used for mode inspection and executed in the state machine thread.
virtual JsonPayload	ActionGetDeferredModes ()
	Action is used for mode inspection and executed in the state machine thread.
virtual void	ActivityWritingBack (StopToken st, const JsonPayload &arg)
	Activity executed in its own thread that performs the writeback.
virtual bool	GuardWritingBackAllowed (const JsonPayload &arg)
	Determines if writeback is possible at this time with the provided argument.
virtual void	ActivityRecovering (StopToken st)
	Activity executed in its own thread that performs the error recovery.

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.

Thread Safety

thread-safe – Method is invoked from unspecified thread and must be thread safe.

Exception Safety

basic – Method may throw an exception. The exception message will be returned to the requestor.

Reimplemented in rtctk::rtcSupervisor::RtcSupervisor.

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.

Thread Safety

thread-safe – Method is invoked from unspecified thread and must be thread safe.

Exception Safety

basic – Method may throw an exception. The exception message will be returned to the requestor.

Reimplemented in rtctk::rtcSupervisor::RtcSupervisor.

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.

Thread Safety

thread-safe – Method is invoked from unspecified thread and must be thread safe.

Exception Safety

basic – Method may throw an exception. The exception message will be returned to the requestor.

Reimplemented in rtctk::rtcSupervisor::RtcSupervisor.

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.

Thread Safety

thread-safe – Method is invoked from unspecified thread and must be thread safe.

Exception Safety

basic – Method may throw an exception. The exception message will be returned to the requestor.

Reimplemented in rtctk::rtcSupervisor::RtcSupervisor.

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.

Parameters

arg	Provides arguments for the mode setting to be performed.

Thread Safety

thread-safe – Method is invoked from unspecified thread and must be thread safe.

Exception Safety

basic – Method may throw an exception. The exception message will be returned to the requestor.

Reimplemented in rtctk::rtcSupervisor::RtcSupervisor.

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.

Parameters

st	Indicates when activity is requested to stop.

Thread Safety

thread-safe – Method is invoked from unspecified thread and must be thread safe.

Exception Safety

basic – Method may throw an exception. The exception message will be returned to the requestor.

Reimplemented in rtctk::rtcSupervisor::RtcSupervisor.

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.

Parameters

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

Thread Safety

thread-safe – Method is invoked from an unspecified thread and must be thread safe.

Exception Safety

basic – Method may throw an exception. The exception message will be returned to the requestor.

Reimplemented in rtctk::rtcSupervisor::RtcSupervisor.

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.

Parameters

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

Thread Safety

thread-safe – Method is invoked from unspecified thread and must be thread safe.

Exception Safety

basic – Method may throw an exception. The exception message will be returned to the requestor.

Reimplemented in rtctk::rtcSupervisor::RtcSupervisor.

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.

Reimplemented in rtctk::rtcSupervisor::RtcSupervisor.

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.

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 WriteBack request being rejected.

Reimplemented in rtctk::rtcSupervisor::RtcSupervisor.

---

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

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