OpenTwin 0.1
OpenTwin
 
Loading...
Searching...
No Matches
ot::ActionHandleConnectorBase Class Referenceabstract

Base class for action handler connectors. A action handle connector has a set of actions. More...

#include "ActionHandleConnectorBase.h"

Public Member Functions

 ActionHandleConnectorBase (const std::string &_actionName, ot::MessageType _messageFlags)
 
 ActionHandleConnectorBase (const std::list< std::string > &_actionNames, ot::MessageType _messageFlags)
 
 ActionHandleConnectorBase (const ActionHandleConnectorBase &_other)
 
virtual ~ActionHandleConnectorBase ()
 
ActionHandleConnectorBaseoperator= (const ActionHandleConnectorBase &_other)
 
bool mayDispatch (ot::MessageType _inboundMessageType) const
 
virtual std::string forwardDispatch (JsonDocument &_document)=0
 
const std::list< std::string > & actionNames (void) const
 

Protected Attributes

std::list< std::string > m_actionNames
 
ot::MessageType m_messageFlags
 

Detailed Description

Base class for action handler connectors. A action handle connector has a set of actions.

Constructor & Destructor Documentation

◆ ActionHandleConnectorBase() [1/3]

ot::ActionHandleConnectorBase::ActionHandleConnectorBase ( const std::string & _actionName,
ot::MessageType _messageFlags )

◆ ActionHandleConnectorBase() [2/3]

ot::ActionHandleConnectorBase::ActionHandleConnectorBase ( const std::list< std::string > & _actionNames,
ot::MessageType _messageFlags )

◆ ActionHandleConnectorBase() [3/3]

ot::ActionHandleConnectorBase::ActionHandleConnectorBase ( const ActionHandleConnectorBase & _other)

◆ ~ActionHandleConnectorBase()

ot::ActionHandleConnectorBase::~ActionHandleConnectorBase ( )
virtual

Member Function Documentation

◆ actionNames()

const std::list< std::string > & ot::ActionHandleConnectorBase::actionNames ( void ) const
inline

◆ forwardDispatch()

virtual std::string ot::ActionHandleConnectorBase::forwardDispatch ( JsonDocument & _document)
pure virtual

◆ mayDispatch()

bool ot::ActionHandleConnectorBase::mayDispatch ( ot::MessageType _inboundMessageType) const

◆ operator=()

ot::ActionHandleConnectorBase & ot::ActionHandleConnectorBase::operator= ( const ActionHandleConnectorBase & _other)

Member Data Documentation

◆ m_actionNames

std::list<std::string> ot::ActionHandleConnectorBase::m_actionNames
protected

◆ m_messageFlags

ot::MessageType ot::ActionHandleConnectorBase::m_messageFlags
protected

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