sensorfw
Proximity Class Reference

QObject facade for ProximityData. More...

#include <proximity.h>

Inheritance diagram for Proximity:
Unsigned

List of all members.

Public Member Functions

 Proximity ()
 Default constructor.
 Proximity (const ProximityData &data)
 Constructor.
 Proximity (const Proximity &data)
 Copy constructor.
const ProximityDataproximityData () const
 Returns the contained ProximityData.
bool withinProximity () const
 Accessor for proximity status.
int reflectance () const
 Accessor for raw reflectance reading.
Proximityoperator= (const Proximity &origin)
 Assignment operator.
bool operator== (const Proximity &right) const
 Comparison operator.

Properties

int reflectance
int withinProximity

Friends

const QDBusArgument & operator>> (const QDBusArgument &argument, Proximity &data)
 Unmarshall Proximity data from the D-Bus argument.

Detailed Description

QObject facade for ProximityData.

Definition at line 37 of file proximity.h.


Constructor & Destructor Documentation

Proximity::Proximity ( ) [inline]

Default constructor.

Definition at line 49 of file proximity.h.

Proximity::Proximity ( const ProximityData data) [inline]

Constructor.

Parameters:
dataSource object.

Definition at line 56 of file proximity.h.

Proximity::Proximity ( const Proximity data) [inline]

Copy constructor.

Parameters:
dataSource object.

Definition at line 66 of file proximity.h.


Member Function Documentation

Proximity& Proximity::operator= ( const Proximity origin) [inline]

Assignment operator.

Parameters:
originSource object for assigment.

Definition at line 95 of file proximity.h.

bool Proximity::operator== ( const Proximity right) const [inline]

Comparison operator.

Parameters:
rightObject to compare to.
Returns:
comparison result.

Definition at line 107 of file proximity.h.

const ProximityData& Proximity::proximityData ( ) const [inline]

Returns the contained ProximityData.

Returns:
Contained ProximityData

Definition at line 74 of file proximity.h.

int Proximity::reflectance ( ) const [inline]

Accessor for raw reflectance reading.

Returns:
proximity reflectance reading.

Definition at line 88 of file proximity.h.

bool Proximity::withinProximity ( ) const [inline]

Accessor for proximity status.

Returns:
is an object in proximity of sensor or not

Definition at line 81 of file proximity.h.


Friends And Related Function Documentation

const QDBusArgument& operator>> ( const QDBusArgument &  argument,
Proximity data 
) [friend]

Unmarshall Proximity data from the D-Bus argument.

Parameters:
argumentdbus argument.
dataunmarshalled data.
Returns:
dbus argument.

Definition at line 145 of file proximity.h.


Property Documentation

Definition at line 41 of file proximity.h.

Definition at line 42 of file proximity.h.


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