Public Slots | Signals | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Properties

MagnetometerSensorChannelInterface Class Reference

Client interface for accessing magnetometer sensor. More...

#include <magnetometersensor_i.h>

Inheritance diagram for MagnetometerSensorChannelInterface:
AbstractSensorChannelInterface

List of all members.

Public Slots

QDBusReply< void > reset ()
 Reset magnetometer calibration to 0.

Signals

void dataAvailable (const MagneticField &data)
 Sent when new measurement is available.
void frameAvailable (const QVector< MagneticField > &frame)
 Sent when new measurement frame has become available.

Public Member Functions

MagneticField magneticField ()
 Get latest magnetometer reading from sensor daemon.
 MagnetometerSensorChannelInterface (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
MagnetometerSensorChannelInterface
listenInterface (const QString &id)
 Request a listening interface to the sensor.
static
MagnetometerSensorChannelInterface
controlInterface (const QString &id)
 Request a control interface to the sensor.
static
MagnetometerSensorChannelInterface
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 void connectNotify (const char *signal)
virtual bool dataReceivedImpl ()
 Callback for subclasses in which they must read their expected data from socket.

Properties

MagneticField magneticField

Detailed Description

Client interface for accessing magnetometer sensor.

Definition at line 40 of file magnetometersensor_i.h.


Constructor & Destructor Documentation

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

Constructor.

Parameters:
path path.
sessionId session id.

Member Function Documentation

virtual void MagnetometerSensorChannelInterface::connectNotify ( const char *  signal  )  [protected, virtual]
static MagnetometerSensorChannelInterface* MagnetometerSensorChannelInterface::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 MagnetometerSensorChannelInterface::dataAvailable ( const MagneticField data  )  [signal]

Sent when new measurement is available.

Parameters:
data Current magnetic field measurement.
virtual bool MagnetometerSensorChannelInterface::dataReceivedImpl (  )  [protected, virtual]

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

Returns:
was read successful.

Implements AbstractSensorChannelInterface.

static AbstractSensorChannelInterface* MagnetometerSensorChannelInterface::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.
void MagnetometerSensorChannelInterface::frameAvailable ( const QVector< MagneticField > &  frame  )  [signal]

Sent when new measurement frame has become available.

If app doesn't connect to this signal content of frames will be sent through dataAvailable signal.

Parameters:
frame New measurement frame.
static MagnetometerSensorChannelInterface* MagnetometerSensorChannelInterface::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 MagnetometerSensorChannelInterface* MagnetometerSensorChannelInterface::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.
MagneticField MagnetometerSensorChannelInterface::magneticField (  ) 

Get latest magnetometer reading from sensor daemon.

Returns:
magnetometer reading.
QDBusReply<void> MagnetometerSensorChannelInterface::reset (  )  [slot]

Reset magnetometer calibration to 0.

Returns:
DBus reply.

Member Data Documentation

Name of the D-Bus interface for this class.

Definition at line 50 of file magnetometersensor_i.h.


Property Documentation

MagneticField MagnetometerSensorChannelInterface::magneticField [read]

Definition at line 44 of file magnetometersensor_i.h.


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