DriveEvent Namespace Reference

Functions
void	AddListener (DriveEventListener *observer, bool priority=false)
	Register a listener object to receive drive events.
void	RemoveListener (DriveEventListener *observer)
	Unregister a listener object.
void	AddListenerOnComplete (void(*onComplete)(uint16_t id))
	Register a C-style callback for “command complete” events.
void	RemoveListenerOnComplete (void(*onComplete)(uint16_t id))
	Remove a previously registered “command complete” callback.
void	AddListenerOnError (void(*onError)(uint16_t id, DriveMotorSide side, DriveErrorType type))
	Register a C-style callback for error events.
void	RemoveListenerOnError (void(*onError)(uint16_t id, DriveMotorSide side, DriveErrorType type))
	Remove a previously registered error callback.
void	AddListenerOnStateChange (void(*onChange)(DriveType drive_type, DriveState state))
	Register a C-style callback for drive state changes.
void	RemoveListenerOnStateChange (void(*onChange)(DriveType drive_type, DriveState state))
	Remove a previously registered state-change callback.

Function Documentation

AddListener()

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

Register a listener object to receive drive events.

Parameters

observer	Pointer to a listener instance (must not be null).
priority	If true, the listener is inserted with priority ordering (implementation-defined).

Warning

The listener object must remain valid until removed with RemoveListener().

Note

Callbacks are typically invoked from an internal worker/event thread.

AddListenerOnComplete()

void DriveEvent::AddListenerOnComplete

(

void(*

onComplete )(uint16_t id)

)

Register a C-style callback for “command complete” events.

Parameters

onComplete

Function pointer called with (id).

Warning

The callback is invoked asynchronously (often from a worker/event thread).

Examples

DriveControl/main.cpp.

AddListenerOnError()

void DriveEvent::AddListenerOnError

(

void(*

onError )(uint16_t id, DriveMotorSide side, DriveErrorType type)

)

Register a C-style callback for error events.

Parameters

onError

Function pointer called with (id, side, type).

Warning

The callback is invoked asynchronously (often from a worker/event thread).

Examples

DriveControl/main.cpp.

AddListenerOnStateChange()

void DriveEvent::AddListenerOnStateChange

(

void(*

onChange )(DriveType drive_type, DriveState state)

)

Register a C-style callback for drive state changes.

Parameters

onChange

Function pointer called with (drive_type, state).

Warning

The callback is invoked asynchronously (often from a worker/event thread).

Examples

DriveControl/main.cpp.

RemoveListener()

void DriveEvent::RemoveListener

(

DriveEventListener *

observer

)

Unregister a listener object.

Parameters

observer

Pointer previously passed to AddListener().

RemoveListenerOnComplete()

void DriveEvent::RemoveListenerOnComplete

(

void(*

onComplete )(uint16_t id)

)

Remove a previously registered “command complete” callback.

Parameters

onComplete

Same function pointer passed to AddListenerOnComplete().

Examples

DriveControl/main.cpp.

RemoveListenerOnError()

void DriveEvent::RemoveListenerOnError

(

void(*

onError )(uint16_t id, DriveMotorSide side, DriveErrorType type)

)

Remove a previously registered error callback.

Parameters

onError

Same function pointer passed to AddListenerOnError().

Examples

DriveControl/main.cpp.

RemoveListenerOnStateChange()

void DriveEvent::RemoveListenerOnStateChange

(

void(*

onChange )(DriveType drive_type, DriveState state)

)

Remove a previously registered state-change callback.

Parameters

onChange

Same function pointer passed to AddListenerOnStateChange().

Examples

DriveControl/main.cpp.