qtmobility/src/sensors/qcompass.cpp
changeset 4 90517678cc4f
parent 1 2b40d63a9c3d
child 5 453da2cfceef
equal deleted inserted replaced
1:2b40d63a9c3d 4:90517678cc4f
    61     If the device is not calibrated the azimuth may not be accurate.
    61     If the device is not calibrated the azimuth may not be accurate.
    62 
    62 
    63     Digital compasses are susceptible to magnetic interference and may need
    63     Digital compasses are susceptible to magnetic interference and may need
    64     calibration after being placed near anything that emits a magnetic force.
    64     calibration after being placed near anything that emits a magnetic force.
    65     Accuracy of the compass can be affected by any ferrous materials that are nearby.
    65     Accuracy of the compass can be affected by any ferrous materials that are nearby.
    66 */
       
    67 
    66 
    68 /*!
    67     The calibration status of the device is measured as a number from 0 to 1.
    69     \enum QCompassReading::CalibrationLevel
    68     A value of 1 is the highest level that the device can support and 0 is
    70 
    69     the worst.
    71     \value Undefined The calibration level is not defined or is too low.
       
    72     \value Low       The reported azimuth may be off by up to 15.4 degrees.
       
    73     \value Middle    The reported azimuth may be off by up to 11.8 degrees.
       
    74     \value High      The reported azimuth may be off by up to 7.4 degrees.
       
    75 */
    70 */
    76 
    71 
    77 /*!
    72 /*!
    78     \property QCompassReading::azimuth
    73     \property QCompassReading::azimuth
    79     \brief the azimuth of the device.
    74     \brief the azimuth of the device.
    98 
    93 
    99 /*!
    94 /*!
   100     \property QCompassReading::calibrationLevel
    95     \property QCompassReading::calibrationLevel
   101     \brief the calibration level of the reading.
    96     \brief the calibration level of the reading.
   102 
    97 
   103     The higher the calibration, the more accurate the measurement is.
    98     Measured as a value from 0 to 1 with higher values being better.
   104     \sa {QCompassReading Units}
    99     \sa {QCompassReading Units}
   105 */
   100 */
   106 
   101 
   107 QCompassReading::CalibrationLevel QCompassReading::calibrationLevel() const
   102 qreal QCompassReading::calibrationLevel() const
   108 {
   103 {
   109     return static_cast<QCompassReading::CalibrationLevel>(d->calibrationLevel);
   104     return d->calibrationLevel;
   110 }
   105 }
   111 
   106 
   112 /*!
   107 /*!
   113     Sets the calibration level of the reading to \a calibrationLevel.
   108     Sets the calibration level of the reading to \a calibrationLevel.
   114 */
   109 */
   115 void QCompassReading::setCalibrationLevel(QCompassReading::CalibrationLevel calibrationLevel)
   110 void QCompassReading::setCalibrationLevel(qreal calibrationLevel)
   116 {
   111 {
   117     d->calibrationLevel = calibrationLevel;
   112     d->calibrationLevel = calibrationLevel;
   118 }
   113 }
   119 
   114 
   120 // =====================================================================
   115 // =====================================================================
   121 
       
   122 // begin generated code
       
   123 
   116 
   124 /*!
   117 /*!
   125     \class QCompassFilter
   118     \class QCompassFilter
   126     \ingroup sensors_filter
   119     \ingroup sensors_filter
   127 
   120 
   175 
   168 
   176     Returns the reading class for this sensor.
   169     Returns the reading class for this sensor.
   177 
   170 
   178     \sa QSensor::reading()
   171     \sa QSensor::reading()
   179 */
   172 */
   180 // end generated code
       
   181 
   173 
   182 #include "moc_qcompass.cpp"
   174 #include "moc_qcompass.cpp"
   183 QTM_END_NAMESPACE
   175 QTM_END_NAMESPACE
   184 
   176