qtmobility/src/sensors/qsensor.cpp
changeset 8 71781823f776
parent 4 90517678cc4f
child 11 06b8e2af4411
equal deleted inserted replaced
5:453da2cfceef 8:71781823f776
    71 
    71 
    72 /*!
    72 /*!
    73     \class QSensor
    73     \class QSensor
    74     \ingroup sensors_main
    74     \ingroup sensors_main
    75 
    75 
    76     \preliminary
       
    77     \brief The QSensor class represents a single hardware sensor.
    76     \brief The QSensor class represents a single hardware sensor.
    78 
    77 
    79     The life cycle of a sensor is typically:
    78     The life cycle of a sensor is typically:
    80 
    79 
    81     \list
    80     \list
   229 /*!
   228 /*!
   230     \property QSensor::availableDataRates
   229     \property QSensor::availableDataRates
   231     \brief the data rates that the sensor supports.
   230     \brief the data rates that the sensor supports.
   232 
   231 
   233     This is a list of the data rates that the sensor supports.
   232     This is a list of the data rates that the sensor supports.
       
   233     Measured in Hertz.
       
   234 
   234     Entries in the list can represent discrete rates or a
   235     Entries in the list can represent discrete rates or a
   235     continuous range of rates.
   236     continuous range of rates.
   236     A discrete rate is noted by having both values the same.
   237     A discrete rate is noted by having both values the same.
   237 
   238 
   238     See the sensor_explorer example for an example of how to interpret and use
   239     See the sensor_explorer example for an example of how to interpret and use
   247 }
   248 }
   248 
   249 
   249 /*!
   250 /*!
   250     \property QSensor::dataRate
   251     \property QSensor::dataRate
   251     \brief the data rate that the sensor should be run at.
   252     \brief the data rate that the sensor should be run at.
       
   253 
       
   254     Measured in Hertz.
   252 
   255 
   253     The default value is determined by the backend.
   256     The default value is determined by the backend.
   254 
   257 
   255     This should be set before calling start() because the sensor may not
   258     This should be set before calling start() because the sensor may not
   256     notice changes to this value while it is running.
   259     notice changes to this value while it is running.
   449 
   452 
   450 /*!
   453 /*!
   451     \class QSensorFilter
   454     \class QSensorFilter
   452     \ingroup sensors_main
   455     \ingroup sensors_main
   453 
   456 
   454     \preliminary
       
   455     \brief The QSensorFilter class provides an efficient
   457     \brief The QSensorFilter class provides an efficient
   456            callback facility for asynchronous notifications of
   458            callback facility for asynchronous notifications of
   457            sensor changes.
   459            sensor changes.
   458 
   460 
   459     Some sensors (eg. the accelerometer) are often accessed very frequently.
   461     Some sensors (eg. the accelerometer) are often accessed very frequently.
   514 
   516 
   515 /*!
   517 /*!
   516     \class QSensorReading
   518     \class QSensorReading
   517     \ingroup sensors_main
   519     \ingroup sensors_main
   518 
   520 
   519     \preliminary
       
   520     \brief The QSensorReading class holds the readings from the sensor.
   521     \brief The QSensorReading class holds the readings from the sensor.
   521 
   522 
   522     Note that QSensorReading is not particularly useful by itself. The interesting
   523     Note that QSensorReading is not particularly useful by itself. The interesting
   523     data for each sensor is defined in a sub-class of QSensorReading.
   524     data for each sensor is defined in a sub-class of QSensorReading.
   524 */
   525 */