Qt-based BB10 API Examples Documentation

CompassSensor.hpp Example File

     * Copyright (c) 2011, 2012, 2013  BlackBerry Limited.
     * Licensed under the Apache License, Version 2.0 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     * http://www.apache.org/licenses/LICENSE-2.0
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.


    #include <QObject>
    #include <QtSensors/QCompassFilter>


     * The CompassSensor class uses the QCompass class from the QtSensors
     * module to retrieve the current azimuth values from the compass sensor of the device.
    class CompassSensor : public QObject, public QCompassFilter

        // The property to access the azimuth value of the compass sensor
        Q_PROPERTY(qreal azimuth READ azimuth NOTIFY azimuthChanged)

        CompassSensor(QObject *parent = 0);

        // The accessor method for the azimuth property
        qreal azimuth() const;

        // The change notification signal of the azimuth property
        void azimuthChanged();

         * This method is reimplemented from the QCompassFilter interface and is
         * called by the QCompass whenever new values are available.
        bool filter(QCompassReading *reading);

        // The compass sensor
        QCompass m_compassSensor;

        // The azimuth value
        qreal m_azimuth;