camerauis/cameraxui/cxengine/src/sensor/xqsensor.cpp
changeset 19 d9aefe59d544
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/camerauis/cameraxui/cxengine/src/sensor/xqsensor.cpp	Fri Apr 16 14:51:30 2010 +0300
@@ -0,0 +1,103 @@
+/*
+* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:
+*
+*/
+#include "xqsensor.h"
+#include "xqsensor_p.h"
+
+/*!
+    \class XQSensor
+
+    \brief The XQSensor is a base class for available concrete sensors.
+*/
+
+XQSensor::XQSensor(XQSensorPrivate& dd, QObject* parent):
+    QObject(parent), d(&dd)
+{
+}
+
+/*!
+    Destroys the XQSensor object.
+*/
+XQSensor::~XQSensor()
+{
+    delete d;
+}
+
+/*!
+    \enum XQSensor::Error
+
+    This enum defines the possible errors for a XQSensor object.
+*/
+/*! \var XQSensor::Error XQSensor::NoError
+    No error occured.
+*/
+/*! \var XQSensor::Error XQSensor::OutOfMemoryError
+    Not enough memory.
+*/
+/*! \var XQSensor::Error XQSensor::NotFoundError
+    Not found.
+*/
+/*! \var XQSensor::Error XQSensor::UnknownError
+    Unknown error.
+*/
+
+/*!
+    Opens the access to a sensor. If the sensor access can't be opened, the error() method
+    returns an error code
+    \sa close(), startReceiving(), stopReceiving(), error()
+*/
+void XQSensor::open()
+{
+    d->open();
+}
+
+/*!
+    Closes the access to a sensor.
+    \sa open(), startReceiving(), stopReceiving()
+*/
+void XQSensor::close()
+{
+    d->close();
+}
+
+/*!
+    Starts actively monitoring the sensor and emits signals about changes in
+    sensor data.
+    \sa stopReceiving(), error()
+*/
+void XQSensor::startReceiving()
+{
+    d->startReceiving();
+}
+
+/*!
+    Stops monitoring the sensor.
+    \sa startReceiving()
+*/
+void XQSensor::stopReceiving()
+{
+    d->stopReceiving();
+}
+
+/*!
+        \return The current error code or Error XQSensor::NoError if there is no error.
+*/
+XQSensor::Error XQSensor::error() const
+{
+    return d->error();
+}
+
+// End of file