2 // Open Service Platform
3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 // Licensed under the Apache License, Version 2.0 (the License);
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
9 // http://www.apache.org/licenses/LICENSE-2.0
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
19 * @file FUixSensorUserAccelerationSensorData.h
20 * @brief This is the header file for the %UserAccelerationSensorData class.
22 * This header file contains the declarations of the %UserAccelerationSensorData class.
25 #ifndef _FUIX_SENSOR_USER_ACCELERATION_SENSOR_DATA_H_
26 #define _FUIX_SENSOR_USER_ACCELERATION_SENSOR_DATA_H_
28 #include <FOspConfig.h>
29 #include <FUixSensorSensorData.h>
31 namespace Tizen { namespace Uix { namespace Sensor
34 * @class UserAccelerationSensorData
35 * @brief This class stores user-acceleration sensor data, including a time stamp.
39 * @remarks @b Header @b %file: @b \#include @b <FUix.h> @n
40 * @b Library : @b osp-uix
42 * The %UserAccelerationSensorData class stores user-acceleration sensor data, including a time stamp.
44 * For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/uix/sensor_manager.htm">Sensor Manager</a>.
46 class _OSP_EXPORT_ UserAccelerationSensorData
47 : public Tizen::Uix::Sensor::SensorData
51 * This is the default constructor for this class.
55 UserAccelerationSensorData(void);
58 * This is the destructor for this class.
62 virtual ~UserAccelerationSensorData(void);
65 * Copying of objects using this copy constructor is allowed.
69 * @param[in] rhs An instance of %UserAccelerationSensorData
71 UserAccelerationSensorData(const UserAccelerationSensorData& rhs);
74 * Compares the equality of values between two %UserAccelerationSensorData objects by overriding the Tizen::Base::Object::Equals() method.
78 * @return @c true if all the fields in the objects are equal, @n
80 * @param[in] rhs The Tizen::Base::Object with which the comparison is done
81 * @remarks An instance of Tizen::Graphics::Bitmap is not taken into account in the comparisons.
83 virtual bool Equals(const Tizen::Base::Object& rhs) const;
86 * Gets the hash value of the current instance by overriding the Tizen::Base::Object::GetHashCode() method.
90 * @return The hash value of the current instance
92 virtual int GetHashCode(void) const;
95 * Copying of objects using this copy assignment operator is allowed.
99 * @return A reference to this instance
100 * @param[in] rhs An instance of %UserAccelerationSensorData
102 UserAccelerationSensorData& operator =(const UserAccelerationSensorData& rhs);
105 virtual result GetValue(SensorDataKey dataKey, long& value) const;
106 virtual result GetValue(SensorDataKey dataKey, float& value) const;
107 virtual result GetValue(SensorDataKey dataKey, bool& value) const;
111 * The x-axis value of the user-acceleration sensor data
118 * The y-axis value of the user-acceleration sensor data
125 * The z-axis value of the user-acceleration sensor data
130 }; // UserAccelerationSensorData
131 } } } // Tizen::Uix::Sensor
133 #endif // _FUIX_SENSOR_USER_ACCELERATION_SENSOR_DATA_H_