sensorfw: PressureSensorChannelInterface Class Reference

sensorfw

Signals | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Properties | List of all members
PressureSensorChannelInterface Class Reference

Client interface for accessing pressure sensor. More...

`#include <pressuresensor_i.h>`

Inheritance diagram for PressureSensorChannelInterface:

## Signals
void | pressureChanged (const Unsigned &value)
| Sent when measured ambient light intensity has changed. More...

## Public Member Functions
Unsigned | pressure ()
| Get latest pressure from sensor daemon. More...
| PressureSensorChannelInterface (const QString &path, int sessionId)
| Constructor. More...
Public Member Functions inherited from AbstractSensorChannelInterface
virtual | ~AbstractSensorChannelInterface ()
| Destructor. More...
bool | release ()
| Release the sensor instance. More...
int | sessionId () const
| Get ID of the current session. More...
SensorError | errorCode ()
| Get error code of occured local or remote error. More...
QString | errorString ()
| Get error description of occured local or remote error. More...
QString | description ()
| Get description of the sensor. More...
QString | id ()
| Get ID of the sensor. More...
int | interval ()
| Get used sensor sampling interval (in millisecs). More...
void | setInterval (int value)
| Set sensor sampling interval (in millisecs). More...
bool | standbyOverride ()
| Is standby-override enabled or not. More...
bool | setStandbyOverride (bool override)
| Enable or disable standby-override. More...
unsigned int | bufferInterval ()
| Used buffer interval. More...
void | setBufferInterval (unsigned int value)
| Set buffer interval. More...
bool | downsampling ()
| Is downsampling enabled or not. More...
bool | setDownsampling (bool value)
| Enable or disable downsampling. More...
IntegerRangeList | getAvailableBufferIntervals ()
| Returns list of available buffer interval ranges. More...
unsigned int | bufferSize ()
| Get used buffer size. More...
void | setBufferSize (unsigned int value)
| Set buffer size. More...
IntegerRangeList | getAvailableBufferSizes ()
| Returns list of available buffer sizes. More...
QString | type ()
| Textual description about sensor type. More...
virtual QDBusReply< void > | start ()
| Start sensor. More...
virtual QDBusReply< void > | stop ()
| Stop sensor. More...
DataRangeList | getAvailableIntervals ()
| Get the list of available intervals ranges for the sensor. More...
DataRangeList | getAvailableDataRanges ()
| Get the list of available data ranges for the sensor. More...
DataRange | getCurrentDataRange ()
| Get current used data range. More...
void | requestDataRange (DataRange range)
| Request data range. More...
void | removeDataRangeRequest ()
| Remove set data range request. More...
bool | setDataRangeIndex (int dataRangeIndex)
| Request data range by using index which points to the list returned by getAvailableDataRanges(). More...
bool | hwBuffering ()
| Does the sensor driver support buffering or not. More...
bool | isValid () const
| Does the current instance have valid connection established to sensor daemon. More...

## Static Public Member Functions
static AbstractSensorChannelInterface * | factoryMethod (const QString &id, int sessionId)
| Create new instance of the class. More...
static const PressureSensorChannelInterface * | listenInterface (const QString &id)
| Request a listening interface to the sensor. More...
static PressureSensorChannelInterface * | controlInterface (const QString &id)
| Request a control interface to the sensor. More...
static PressureSensorChannelInterface * | interface (const QString &id)
| Request an interface to the sensor. More...

## Static Public Attributes
static const char * | staticInterfaceName
| Name of the D-Bus interface for this class. More...

## Protected Member Functions
virtual bool | dataReceivedImpl ()
| Callback for subclasses in which they must read their expected data from socket. More...
Protected Member Functions inherited from AbstractSensorChannelInterface
| AbstractSensorChannelInterface (const QString &path, const char *interfaceName, int sessionId)
| Constructor. More...
bool | read (void *buffer, int size)
| Read data from socket into buffer. More...
template<typename T >
bool | read (QVector< T > &values)
| Read data from socket into passed container. More...
virtual bool | dataReceivedImpl ()=0
| Callback for subclasses in which they must read their expected data from socket. More...
template<typename T >
T | getAccessor (const char *name)
| Utility for calling DBus methods from current connection which return value and take no args. More...
template<typename T >
void | setAccessor (const char *name, const T &value)
| Utility for calling DBus methods from current connection which return nothing and take one arg. More...
QDBusMessage | call (QDBus::CallMode mode, const QString &method, const QVariant &arg1=QVariant(), const QVariant &arg2=QVariant(), const QVariant &arg3=QVariant(), const QVariant &arg4=QVariant(), const QVariant &arg5=QVariant(), const QVariant &arg6=QVariant(), const QVariant &arg7=QVariant(), const QVariant &arg8=QVariant())
| Wrapper for function of QDBusAbstractInterface. More...
QDBusMessage | callWithArgumentList (QDBus::CallMode mode, const QString &method, const QList< QVariant > &args)
| Wrapper for function of QDBusAbstractInterface. More...
void | dbusConnectNotify (const QMetaMethod &signal)
| Wrapper for function of QDBusAbstractInterface. More...

## Properties
Unsigned | pressure
Properties inherited from AbstractSensorChannelInterface
int | sessionId
SensorError | errorCode
QString | errorString
QString | description
QString | id
int | interval
bool | standbyOverride
QString | type
unsigned int | bufferInterval
unsigned int | bufferSize
bool | hwBuffering
bool | downsampling

## Additional Inherited Members
Protected Slots inherited from AbstractSensorChannelInterface
void | startFinished (QDBusPendingCallWatcher *watch)
void | stopFinished (QDBusPendingCallWatcher *watch)
void | setIntervalFinished (QDBusPendingCallWatcher *watch)
void | setBufferIntervalFinished (QDBusPendingCallWatcher *watch)
void | setBufferSizeFinished (QDBusPendingCallWatcher *watch)
void | setStandbyOverrideFinished (QDBusPendingCallWatcher *watch)
void | setDownsamplingFinished (QDBusPendingCallWatcher *watch)
void | setDataRangeIndexFinished (QDBusPendingCallWatcher *watch)

## Detailed Description

Client interface for accessing pressure sensor.

Provides signal on change of measured pressure level. Previous measured pressure level can be queried any time. Provided values are in pascals.

Definition at line 40 of file pressuresensor_i.h.

## Constructor & Destructor Documentation

## ◆ PressureSensorChannelInterface()

PressureSensorChannelInterface::PressureSensorChannelInterface | ( | const QString & | path,
|  | int | sessionId
| ) |  |

Constructor.

Parameters

  path | path.
  sessionId | session ID.

## Member Function Documentation

## ◆ controlInterface()

static PressureSensorChannelInterface * PressureSensorChannelInterface::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.

## ◆ dataReceivedImpl()

virtual bool PressureSensorChannelInterface::dataReceivedImpl | ( |  | ) |
| protectedvirtual

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

Returns
  was read successful.

Implements AbstractSensorChannelInterface.

## ◆ factoryMethod()

static AbstractSensorChannelInterface * PressureSensorChannelInterface::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.

## ◆ interface()

static PressureSensorChannelInterface * PressureSensorChannelInterface::interface | ( | const QString & | id | ) |
| static

Request an interface to the sensor.

Parameters

  id | sensor ID.

Returns
  Pointer to interface, or NULL on failure.

## ◆ listenInterface()

static const PressureSensorChannelInterface * PressureSensorChannelInterface::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.

## ◆ pressure()

Unsigned PressureSensorChannelInterface::pressure | ( |  | ) |

Get latest pressure from sensor daemon.

Returns
  pressure reading.

## ◆ pressureChanged

void PressureSensorChannelInterface::pressureChanged | ( | const Unsigned & | value | ) |
| signal

Sent when measured ambient light intensity has changed.

Parameters

  value | ambient light reading.

## Member Data Documentation

## ◆ staticInterfaceName

const char* PressureSensorChannelInterface::staticInterfaceName
| static

Name of the D-Bus interface for this class.

Definition at line 50 of file pressuresensor_i.h.

## Property Documentation

## ◆ pressure

Unsigned PressureSensorChannelInterface::pressure
| read

Definition at line 1 of file pressuresensor_i.h.

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

- qt-api/pressuresensor_i.h