diff options
author | Lincoln Ramsay <lincoln.ramsay@nokia.com> | 2011-08-23 11:21:42 +1000 |
---|---|---|
committer | Qt by Nokia <qt-info@nokia.com> | 2011-08-25 07:59:15 +0200 |
commit | fd6f05aa763538309c4d26223f2111be8ec0f82d (patch) | |
tree | 503309c2369b1279eef94f810e45b03e574b7501 /src/qtmsensors/qaccelerometer.cpp | |
parent | 85dc94873bd21d97cd472af77fefa25fecd8618e (diff) |
QtmSensors, legacy sensors library.
QtSensors will not remain source-compatible with Mobility.
QtmSensors exists to provide a source-compatible API.
QtmSensors is implemented as a wrapper over the QtSensors library.
Only front end functionality is supported. Backends must be ported
to QtSensors.
Change-Id: Ia7e45b719fb5f84637f899374990dbd680e259bd
Reviewed-on: http://codereview.qt.nokia.com/3348
Reviewed-by: Qt Sanity Bot <qt_sanity_bot@ovi.com>
Reviewed-by: Zsolt Simon <zsolt.simon@nokia.com>
Diffstat (limited to 'src/qtmsensors/qaccelerometer.cpp')
-rw-r--r-- | src/qtmsensors/qaccelerometer.cpp | 196 |
1 files changed, 196 insertions, 0 deletions
diff --git a/src/qtmsensors/qaccelerometer.cpp b/src/qtmsensors/qaccelerometer.cpp new file mode 100644 index 00000000..0f0765ec --- /dev/null +++ b/src/qtmsensors/qaccelerometer.cpp @@ -0,0 +1,196 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtSensors module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** GNU Lesser General Public License Usage +** This file may be used under the terms of the GNU Lesser General Public +** License version 2.1 as published by the Free Software Foundation and +** appearing in the file LICENSE.LGPL included in the packaging of this +** file. Please review the following information to ensure the GNU Lesser +** General Public License version 2.1 requirements will be met: +** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU General +** Public License version 3.0 as published by the Free Software Foundation +** and appearing in the file LICENSE.GPL included in the packaging of this +** file. Please review the following information to ensure the GNU General +** Public License version 3.0 requirements will be met: +** http://www.gnu.org/copyleft/gpl.html. +** +** Other Usage +** Alternatively, this file may be used in accordance with the terms and +** conditions contained in a signed written agreement between you and Nokia. +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qaccelerometer.h" +#include "qaccelerometer_p.h" + +QT_BEGIN_NAMESPACE +QTM_BEGIN_NAMESPACE + +IMPLEMENT_READING(QAccelerometerReading) + +/*! + \class QAccelerometerReading + \ingroup sensors_reading + \inmodule QtSensors + \since 1.0 + + \brief The QAccelerometerReading class reports on linear acceleration + along the X, Y and Z axes. + + \section2 QAccelerometerReading Units + The scale of the values is meters per second squared. + The axes are arranged as follows. + + \image sensors-coordinates2.jpg + + A monoblock device sitting at rest, face up on a desk will experience + a force of approximately 9.8 on the Z axis (ie. towards the roof). + This is the proper acceleration the device experiences relative to + freefall. +*/ + +/*! + \property QAccelerometerReading::x + \brief the acceleration on the X axis. + + The scale of the values is meters per second squared. + \sa {QAccelerometerReading Units} +*/ + +qreal QAccelerometerReading::x() const +{ + return d->x; +} + +/*! + Sets the acceleration on the X axis to \a x. +*/ +void QAccelerometerReading::setX(qreal x) +{ + d->x = x; +} + +/*! + \property QAccelerometerReading::y + \brief the acceleration on the Y axis. + + The scale of the values is meters per second squared. + \sa {QAccelerometerReading Units} +*/ + +qreal QAccelerometerReading::y() const +{ + return d->y; +} + +/*! + Sets the acceleration on the Y axis to \a y. +*/ +void QAccelerometerReading::setY(qreal y) +{ + d->y = y; +} + +/*! + \property QAccelerometerReading::z + \brief the acceleration on the Z axis. + + The scale of the values is meters per second squared. + \sa {QAccelerometerReading Units} +*/ + +qreal QAccelerometerReading::z() const +{ + return d->z; +} + +/*! + Sets the acceleration on the Z axis to \a z. +*/ +void QAccelerometerReading::setZ(qreal z) +{ + d->z = z; +} + +// ===================================================================== + +/*! + \class QAccelerometerFilter + \ingroup sensors_filter + \inmodule QtSensors + + \brief The QAccelerometerFilter class is a convenience wrapper around QSensorFilter. + + The only difference is that the filter() method features a pointer to QAccelerometerReading + instead of QSensorReading. +*/ + +/*! + \fn QAccelerometerFilter::filter(QAccelerometerReading *reading) + + Called when \a reading changes. Returns false to prevent the reading from propagating. + + \sa QSensorFilter::filter() +*/ + +char const * const QAccelerometer::type("QAccelerometer"); + +/*! + \class QAccelerometer + \ingroup sensors_type + \inmodule QtSensors + + \brief The QAccelerometer class is a convenience wrapper around QSensor. + + The only behavioural difference is that this class sets the type properly. + + This class also features a reading() function that returns a QAccelerometerReading instead of a QSensorReading. + + For details about how the sensor works, see \l QAccelerometerReading. + + \sa QAccelerometerReading +*/ + +/*! + \fn QAccelerometer::QAccelerometer(QObject *parent) + + Construct the sensor as a child of \a parent. +*/ + +/*! + \fn QAccelerometer::~QAccelerometer() + + Destroy the sensor. Stops the sensor if it has not already been stopped. +*/ + +/*! + \fn QAccelerometer::reading() const + + Returns the reading class for this sensor. + + \sa QSensor::reading() +*/ + +#include "moc_qaccelerometer.cpp" +QTM_END_NAMESPACE +QT_END_NAMESPACE + |