An abstract base class for sensor events. More...

#include <SensorEvent.hpp>

Inheritance diagram for SensorEvent:

[legend]

Public Types
enum	Type { Type_Key, Type_Motion, Type_Sensor, Type_Timer }
	Event types. More...

Public Member Functions
virtual	~SensorEvent ()
	Destructor. More...

Accuracy	getAccuracy () const
	Get the accuracy of the sensor event values. More...

float	getValue (int index) const throw ()
	Get a sensor value. More...

virtual time_ms_t	getEventTime () const
	Get the time at which this event occurred. More...

Sensor::Type	getSensorType () const
	Get the sensor type. More...

Type	getType () const
	Get the event type. More...

Detailed Description

An abstract base class for sensor events.

Author: Mark Lindner

Member Enumeration Documentation

◆ Type

enum Type

inherited

Event types.

Enumerator
Type_Key	Key input events.
Type_Motion	Motion input events.
Type_Sensor	Sensor events.
Type_Timer	Timer events.

Constructor & Destructor Documentation

◆ ~SensorEvent()

~SensorEvent ( )

virtual

Destructor.

Member Function Documentation

◆ getAccuracy()

Accuracy getAccuracy ( ) const

inline

Get the accuracy of the sensor event values.

◆ getEventTime()

virtual time_ms_t getEventTime ( ) const

inlinevirtual

Get the time at which this event occurred.

Implements Event.

◆ getSensorType()

Sensor::Type getSensorType ( ) const

inline

Get the sensor type.

◆ getType()

Type getType ( ) const

inlineinherited

Get the event type.

◆ getValue()

float getValue	(	int	index	)	const
throw	(
	)

Get a sensor value.

Parameters

index The value index. Must be between 0 and 15, inclusive. The number of significant values, and the meaning of each, is dependent on the sensor type.

Returns: The sensor value.

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

Public Types

Public Member Functions