DOLY-DIY/cpp/_arm_event_8h_source.html

#pragma once

#include <cstdint>

#include "ArmEventListener.h"


namespace ArmEvent

{

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


    void RemoveListener(ArmEventListener* observer);


    void AddListenerOnComplete(void(*onEvent)(uint16_t id, ArmSide side));


    void RemoveListenerOnComplete(void(*onEvent)(uint16_t id, ArmSide side));


    void AddListenerOnError(void(*onEvent)(uint16_t id, ArmSide side, ArmErrorType errorType));


    void RemoveListenerOnError(void(*onEvent)(uint16_t id, ArmSide side, ArmErrorType errorType));


    void AddListenerOnStateChange(void(*onEvent)(ArmSide side, ArmState state));


    void RemoveListenerOnStateChange(void(*onEvent)(ArmSide side, ArmState state));


    void AddListenerOnMovement(void(*onEvent)(ArmSide side, float degreeChange));


    void RemoveListenerOnMovement(void(*onEvent)(ArmSide side, float degreeChange));


} // namespace ArmEvent


ArmEventListener.h
Public event types and listener interface for Doly ArmControl.

ArmEventListener
Interface for receiving arm events.
Definition ArmEventListener.h:78

ArmState
ArmState
High-level state of an arm operation.
Definition ArmEventListener.h:55

ArmSide
ArmSide
Which arm side an operation or event relates to.
Definition ArmEventListener.h:40

ArmErrorType
ArmErrorType
Error categories reported by the arm subsystem.
Definition ArmEventListener.h:28

ArmEvent
Definition ArmEvent.h:17

ArmEvent::AddListener
void AddListener(ArmEventListener *observer, bool priority=false)
Register a listener object to receive arm events.

ArmEvent::AddListenerOnStateChange
void AddListenerOnStateChange(void(*onEvent)(ArmSide side, ArmState state))
Register a C-style callback for state changes.

ArmEvent::AddListenerOnComplete
void AddListenerOnComplete(void(*onEvent)(uint16_t id, ArmSide side))
Register a C-style callback for �command complete� events.

ArmEvent::AddListenerOnMovement
void AddListenerOnMovement(void(*onEvent)(ArmSide side, float degreeChange))
Register a C-style callback for movement notifications.

ArmEvent::RemoveListenerOnStateChange
void RemoveListenerOnStateChange(void(*onEvent)(ArmSide side, ArmState state))
Remove a previously registered state-change callback.

ArmEvent::RemoveListenerOnComplete
void RemoveListenerOnComplete(void(*onEvent)(uint16_t id, ArmSide side))
Remove a previously registered �command complete� callback.

ArmEvent::AddListenerOnError
void AddListenerOnError(void(*onEvent)(uint16_t id, ArmSide side, ArmErrorType errorType))
Register a C-style callback for error events.

ArmEvent::RemoveListenerOnMovement
void RemoveListenerOnMovement(void(*onEvent)(ArmSide side, float degreeChange))
Remove a previously registered movement callback.

ArmEvent::RemoveListener
void RemoveListener(ArmEventListener *observer)
Unregister a listener object.

ArmEvent::RemoveListenerOnError
void RemoveListenerOnError(void(*onEvent)(uint16_t id, ArmSide side, ArmErrorType errorType))
Remove a previously registered error callback.