ProximitySensorEvent Class Reference

A proximity sensor event, which measures the distance to a nearby object. More...

#include <ProximitySensorEvent.hpp>

Inheritance diagram for ProximitySensorEvent:

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

Public Member Functions
virtual	~ProximitySensorEvent ()
	Destructor. More...
float	getDistance () const
	Get the distance to the nearby object. 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

A proximity sensor event, which measures the distance to a nearby object.

All units are in cm (centimeters).

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

~ProximitySensorEvent()

~ProximitySensorEvent ( )

virtual

Destructor.

Member Function Documentation

getAccuracy()

Accuracy getAccuracy ( ) const

inlineinherited

Get the accuracy of the sensor event values.

getDistance()

float getDistance ( ) const

inline

Get the distance to the nearby object.

getEventTime()

virtual time_ms_t getEventTime ( ) const

inlinevirtualinherited

Get the time at which this event occurred.

Implements Event.

getSensorType()

Sensor::Type getSensorType ( ) const

inlineinherited

Get the sensor type.

getType()

Type getType ( ) const

inlineinherited

Get the event type.

getValue()

float getValue ( int  index ) const throw ( )

inherited

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:

• ProximitySensorEvent.hpp
• ProximitySensorEvent.cpp