Client interface for accessing compass sensor. More...

#include <compasssensor_i.h>

Inheritance diagram for CompassSensorChannelInterface:

Signals
void	dataAvailable (const Compass &value)
	Sent when compass direction or calibration level has changed.
Public Member Functions
Compass	get ()
	Get latest compass reading from sensor daemon.
bool	useDeclination ()
	Returns whether the sensor is applying declination correction to the output value and returning true north, or not applying it and returning magnetic north.
void	setUseDeclination (bool enable)
	Sets whether the declination correction should be applied or not.
int	declinationValue ()
	Returns the currently used declination correction value.
	CompassSensorChannelInterface (const QString &path, int sessionId)
	Constructor.
Static Public Member Functions
static AbstractSensorChannelInterface *	factoryMethod (const QString &id, int sessionId)
	Create new instance of the class.
static const CompassSensorChannelInterface *	listenInterface (const QString &id)
	Request a listening interface to the sensor.
static CompassSensorChannelInterface *	controlInterface (const QString &id)
	Request a control interface to the sensor.
static CompassSensorChannelInterface *	interface (const QString &id)
	Request an interface to the sensor.
Static Public Attributes
static const char *	staticInterfaceName
	Name of the D-Bus interface for this class.
Protected Member Functions
virtual bool	dataReceivedImpl ()
	Callback for subclasses in which they must read their expected data from socket.
Properties
Compass	value
bool	usedeclination
int	declinationvalue

Detailed Description

Client interface for accessing compass sensor.

Definition at line 38 of file compasssensor_i.h.

Constructor & Destructor Documentation

CompassSensorChannelInterface::CompassSensorChannelInterface	(	const QString &	path,
		int	sessionId
	)

Constructor.

Parameters:

path	path.
sessionId	session ID.

Member Function Documentation

static CompassSensorChannelInterface* CompassSensorChannelInterface::controlInterface ( const QString & id ) [static]

Request a control interface to the sensor.

Parameters:

id	sensor ID.

Returns:: Pointer to interface, or NULL on failure.

Deprecated:: use interface(const QString&) instead.

void CompassSensorChannelInterface::dataAvailable ( const Compass & value ) [signal]

Sent when compass direction or calibration level has changed.

Parameters:

value Current compass measurement.

virtual bool CompassSensorChannelInterface::dataReceivedImpl ( ) [protected, virtual]

Callback for subclasses in which they must read their expected data from socket.

Returns:: was read successful.

Implements AbstractSensorChannelInterface.

int CompassSensorChannelInterface::declinationValue ( )

Returns the currently used declination correction value.

Returns:: Current declination value

static AbstractSensorChannelInterface* CompassSensorChannelInterface::factoryMethod	(	const QString &	id,
		int	sessionId
	)		`[static]`

Create new instance of the class.

Parameters:

id	Sensor ID.
sessionId	Session ID.

Returns:: Pointer to new instance of the class.

Compass CompassSensorChannelInterface::get ( )

Get latest compass reading from sensor daemon.

Returns:: compass reading.

static CompassSensorChannelInterface* CompassSensorChannelInterface::interface ( const QString & id ) [static]

Request an interface to the sensor.

Parameters:

id	sensor ID.

Returns:: Pointer to interface, or NULL on failure.

static const CompassSensorChannelInterface* CompassSensorChannelInterface::listenInterface ( const QString & id ) [static]

Request a listening interface to the sensor.

Parameters:

id	sensor ID.

Returns:: Pointer to interface, or NULL on failure.

Deprecated:: use interface(const QString&) instead.

void CompassSensorChannelInterface::setUseDeclination ( bool enable )

Sets whether the declination correction should be applied or not.

Parameters:

enable If true, declination correction will be applied, if false, it will not be applied

bool CompassSensorChannelInterface::useDeclination ( )

Returns whether the sensor is applying declination correction to the output value and returning true north, or not applying it and returning magnetic north.