Motion Master
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Notifier Class Referenceabstract

#include <notifier.h>

Inheritance diagram for Notifier:
Inheritance graph
[legend]

Public Member Functions

virtual ~Notifier ()=default
 
virtual void send_slave_warning (uint32_t device_address, int32_t device_id, int32_t code, const std::string &additional_info="")=0
 
virtual void send_slave_error (uint32_t device_address, int32_t device_id, int32_t code, const std::string &additional_info="")=0
 
virtual void send_status (motionmaster::MotionMasterMessage::Status *status, std::string topic="")=0
 
virtual void send_monitoring_status (motionmaster::MotionMasterMessage::Status *status)=0
 
virtual void send_notification_status (motionmaster::MotionMasterMessage::Status *status)=0
 
virtual void send_mm_state_waiting_for_slaves ()=0
 
virtual void send_mm_state_slaves_found ()=0
 
virtual void send_mm_state_initializing ()=0
 
virtual void send_mm_state_initialized ()=0
 
virtual void send_mm_state_deinitializing ()=0
 
virtual void send_mm_state_deinitialized ()=0
 
virtual void send_mm_state_terminating ()=0
 
virtual bool has_notification ()=0
 
virtual bool get_next_notification (OutgoingMachineMessage &message)=0
 Get the next notification from the notification queue. More...
 

Constructor & Destructor Documentation

◆ ~Notifier()

virtual Notifier::~Notifier ( )
virtualdefault

Member Function Documentation

◆ get_next_notification()

virtual bool Notifier::get_next_notification ( OutgoingMachineMessage message)
pure virtual

Get the next notification from the notification queue.

Used by the Server to get the notifications in order to forward them to the clients. A simple queue is used that has a mutex lock which may, or may not be successfully obtained at the moment of checking.

Parameters
messageoutput parameter
Returns
true if a notification has been successfully fetched, false if not

Implemented in NotifierImpl.

◆ has_notification()

virtual bool Notifier::has_notification ( )
pure virtual

Implemented in NotifierImpl.

◆ send_mm_state_deinitialized()

virtual void Notifier::send_mm_state_deinitialized ( )
pure virtual

Implemented in NotifierImpl.

◆ send_mm_state_deinitializing()

virtual void Notifier::send_mm_state_deinitializing ( )
pure virtual

Implemented in NotifierImpl.

◆ send_mm_state_initialized()

virtual void Notifier::send_mm_state_initialized ( )
pure virtual

Implemented in NotifierImpl.

◆ send_mm_state_initializing()

virtual void Notifier::send_mm_state_initializing ( )
pure virtual

Implemented in NotifierImpl.

◆ send_mm_state_slaves_found()

virtual void Notifier::send_mm_state_slaves_found ( )
pure virtual

Implemented in NotifierImpl.

◆ send_mm_state_terminating()

virtual void Notifier::send_mm_state_terminating ( )
pure virtual

Implemented in NotifierImpl.

◆ send_mm_state_waiting_for_slaves()

virtual void Notifier::send_mm_state_waiting_for_slaves ( )
pure virtual

Implemented in NotifierImpl.

◆ send_monitoring_status()

virtual void Notifier::send_monitoring_status ( motionmaster::MotionMasterMessage::Status *  status)
pure virtual

Implemented in NotifierImpl.

◆ send_notification_status()

virtual void Notifier::send_notification_status ( motionmaster::MotionMasterMessage::Status *  status)
pure virtual

Implemented in NotifierImpl.

◆ send_slave_error()

virtual void Notifier::send_slave_error ( uint32_t  device_address,
int32_t  device_id,
int32_t  code,
const std::string &  additional_info = "" 
)
pure virtual

Implemented in NotifierImpl.

◆ send_slave_warning()

virtual void Notifier::send_slave_warning ( uint32_t  device_address,
int32_t  device_id,
int32_t  code,
const std::string &  additional_info = "" 
)
pure virtual

Implemented in NotifierImpl.

◆ send_status()

virtual void Notifier::send_status ( motionmaster::MotionMasterMessage::Status *  status,
std::string  topic = "" 
)
pure virtual

Implemented in NotifierImpl.


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