ArmEvent Namespace Reference

Functions
void	AddListener (ArmEventListener *observer, bool priority=false)
	Register a listener object to receive arm events.
void	RemoveListener (ArmEventListener *observer)
	Unregister a listener object.
void	AddListenerOnComplete (void(*onEvent)(uint16_t id, ArmSide side))
	Register a C-style callback for “command complete” events.
void	RemoveListenerOnComplete (void(*onEvent)(uint16_t id, ArmSide side))
	Remove a previously registered “command complete” callback.
void	AddListenerOnError (void(*onEvent)(uint16_t id, ArmSide side, ArmErrorType errorType))
	Register a C-style callback for error events.
void	RemoveListenerOnError (void(*onEvent)(uint16_t id, ArmSide side, ArmErrorType errorType))
	Remove a previously registered error callback.
void	AddListenerOnStateChange (void(*onEvent)(ArmSide side, ArmState state))
	Register a C-style callback for state changes.
void	RemoveListenerOnStateChange (void(*onEvent)(ArmSide side, ArmState state))
	Remove a previously registered state-change callback.
void	AddListenerOnMovement (void(*onEvent)(ArmSide side, float degreeChange))
	Register a C-style callback for movement notifications.
void	RemoveListenerOnMovement (void(*onEvent)(ArmSide side, float degreeChange))
	Remove a previously registered movement callback.

Function Documentation

AddListener()

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

Register a listener object to receive arm 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 ArmEvent::AddListenerOnComplete

(

void(*

onEvent )(uint16_t id, ArmSide side)

)

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

Parameters

onEvent

Function pointer called with (id, side).

Warning

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

Note

You can register multiple callbacks (implementation-defined).

Examples

ArmControl/main.cpp.

AddListenerOnError()

void ArmEvent::AddListenerOnError

(

void(*

onEvent )(uint16_t id, ArmSide side, ArmErrorType errorType)

)

Register a C-style callback for error events.

Parameters

onEvent

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

Warning

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

Examples

ArmControl/main.cpp.

AddListenerOnMovement()

void ArmEvent::AddListenerOnMovement

(

void(*

onEvent )(ArmSide side, float degreeChange)

)

Register a C-style callback for movement notifications.

Parameters

onEvent

Function pointer called with (side, degreeChange).

Warning

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

Examples

ArmControl/main.cpp.

AddListenerOnStateChange()

void ArmEvent::AddListenerOnStateChange

(

void(*

onEvent )(ArmSide side, ArmState state)

)

Register a C-style callback for state changes.

Parameters

onEvent

Function pointer called with (side, state).

Warning

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

Examples

ArmControl/main.cpp.

RemoveListener()

void ArmEvent::RemoveListener

(

ArmEventListener *

observer

)

Unregister a listener object.

Parameters

observer

Pointer previously passed to AddListener().

RemoveListenerOnComplete()

void ArmEvent::RemoveListenerOnComplete

(

void(*

onEvent )(uint16_t id, ArmSide side)

)

Remove a previously registered “command complete” callback.

Parameters

onEvent

Same function pointer passed to AddListenerOnComplete().

Examples

ArmControl/main.cpp.

RemoveListenerOnError()

void ArmEvent::RemoveListenerOnError

(

void(*

onEvent )(uint16_t id, ArmSide side, ArmErrorType errorType)

)

Remove a previously registered error callback.

Parameters

onEvent

Same function pointer passed to AddListenerOnError().

Examples

ArmControl/main.cpp.

RemoveListenerOnMovement()

void ArmEvent::RemoveListenerOnMovement

(

void(*

onEvent )(ArmSide side, float degreeChange)

)

Remove a previously registered movement callback.

Parameters

onEvent

Same function pointer passed to AddListenerOnMovement().

Examples

ArmControl/main.cpp.

RemoveListenerOnStateChange()

void ArmEvent::RemoveListenerOnStateChange

(

void(*

onEvent )(ArmSide side, ArmState state)

)

Remove a previously registered state-change callback.

Parameters

onEvent

Same function pointer passed to AddListenerOnStateChange().

Examples

ArmControl/main.cpp.