OpenTwin 0.1
OpenTwin
 
Loading...
Searching...
No Matches
ak::aNotifier Class Referenceabstract

This abstract class is used to provide the receiver functionallity used in the messaging class. More...

#include "aNotifier.h"

Inheritance diagram for ak::aNotifier:
AppBase ExternalServicesComponent ToolBar ViewerComponent ak::aNotifierObjectManager

Public Member Functions

 aNotifier ()
 Will initialize the notifier.
 
virtual ~aNotifier ()
 Destructor.
 
virtual void notify (ak::UID _senderId, ak::eventType _event, int _info1, int _info2)=0
 Will notify this receiver that a message was received by a sender.
 
void enable (void)
 Will enable this notifier.
 
void disable (void)
 Will disable this notifier.
 
bool isEnabled (void) const
 Will return true if this notifier is enabled.
 

Protected Attributes

bool m_isEnabled
 

Detailed Description

This abstract class is used to provide the receiver functionallity used in the messaging class.

Constructor & Destructor Documentation

◆ aNotifier()

ak::aNotifier::aNotifier ( )

Will initialize the notifier.

◆ ~aNotifier()

virtual ak::aNotifier::~aNotifier ( )
inlinevirtual

Destructor.

Member Function Documentation

◆ disable()

void ak::aNotifier::disable ( void )

Will disable this notifier.

◆ enable()

void ak::aNotifier::enable ( void )

Will enable this notifier.

◆ isEnabled()

bool ak::aNotifier::isEnabled ( void ) const

Will return true if this notifier is enabled.

◆ notify()

virtual void ak::aNotifier::notify ( ak::UID _senderId,
ak::eventType _event,
int _info1,
int _info2 )
pure virtual

Will notify this receiver that a message was received by a sender.

Parameters
_senderIdThe id of the sender the message was sent from
_eventThe event message
_info1Message addition 1
_info2Message addition 2
Exceptions
std::exceptionon any error occuring during the execution

Implemented in ToolBar, ExternalServicesComponent, ViewerComponent, AppBase, and ak::aNotifierObjectManager.

Member Data Documentation

◆ m_isEnabled

bool ak::aNotifier::m_isEnabled
protected

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