DOLY-DIY/cpp/_drive_event_8h_source.html

#pragma once

#include "DriveEventListener.h"


namespace DriveEvent

{

    void AddListener(DriveEventListener* observer, bool priority = false);


    void RemoveListener(DriveEventListener* observer);


    void AddListenerOnComplete(void(*onComplete)(uint16_t id));


    void RemoveListenerOnComplete(void(*onComplete)(uint16_t id));


    void AddListenerOnError(void(*onError)(uint16_t id, DriveMotorSide side, DriveErrorType type));


    void RemoveListenerOnError(void(*onError)(uint16_t id, DriveMotorSide side, DriveErrorType type));


    void AddListenerOnStateChange(void(*onChange)(DriveType drive_type, DriveState state));


    void RemoveListenerOnStateChange(void(*onChange)(DriveType drive_type, DriveState state));


} // namespace DriveEvent


DriveEventListener.h
Public API types and listener interface for DriveControl.

DriveEventListener
Interface for receiving drive events.
Definition DriveEventListener.h:102

DriveErrorType
DriveErrorType
Classification of a drive error.
Definition DriveEventListener.h:28

DriveType
DriveType
Type/category of a drive operation.
Definition DriveEventListener.h:76

DriveState
DriveState
High-level state of a drive operation.
Definition DriveEventListener.h:61

DriveMotorSide
DriveMotorSide
Which motor side is associated with an error/event.
Definition DriveEventListener.h:46

DriveEvent
Definition DriveEvent.h:16

DriveEvent::RemoveListenerOnError
void RemoveListenerOnError(void(*onError)(uint16_t id, DriveMotorSide side, DriveErrorType type))
Remove a previously registered error callback.

DriveEvent::AddListenerOnComplete
void AddListenerOnComplete(void(*onComplete)(uint16_t id))
Register a C-style callback for “command complete” events.

DriveEvent::AddListener
void AddListener(DriveEventListener *observer, bool priority=false)
Register a listener object to receive drive events.

DriveEvent::RemoveListenerOnStateChange
void RemoveListenerOnStateChange(void(*onChange)(DriveType drive_type, DriveState state))
Remove a previously registered state-change callback.

DriveEvent::AddListenerOnError
void AddListenerOnError(void(*onError)(uint16_t id, DriveMotorSide side, DriveErrorType type))
Register a C-style callback for error events.

DriveEvent::RemoveListener
void RemoveListener(DriveEventListener *observer)
Unregister a listener object.

DriveEvent::RemoveListenerOnComplete
void RemoveListenerOnComplete(void(*onComplete)(uint16_t id))
Remove a previously registered “command complete” callback.

DriveEvent::AddListenerOnStateChange
void AddListenerOnStateChange(void(*onChange)(DriveType drive_type, DriveState state))
Register a C-style callback for drive state changes.