src/modules/API/Haptics/HapticPattern.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /**
  17  *
  18  *
  19  * @file       HapticPattern.h
  20  * @author     Krzysztof Jackiewicz (k.jackiewicz@samsung.com)
  21  * @version    0.1
  22  * @brief
  23  */
  24
  25 #ifndef WRTDEVICEAPIS_HAPTIC_HAPTICPATTERN_H_
  26 #define WRTDEVICEAPIS_HAPTIC_HAPTICPATTERN_H_
  27
  28 #include <vector>
  29 #include <dpl/noncopyable.h>
  30 #include <dpl/shared_ptr.h>
  31
  32 namespace WrtDeviceApis {
  33 namespace Haptics {
  34 namespace Api {
  35 /*
  36  *
  37  */
  38 class HapticPattern : public DPL::Noncopyable
  39 {
  40   public:
  41     // adds another interval to the sequence
  42     void addInterval(unsigned long duration,
  43             bool active);
  44
  45     // sequence length
  46     size_t length() const
  47     {
  48         return m_sequence.size();
  49     }
  50
  51     // returns true if during given interval the haptic action is on
  52     // throws Commons::OutOfRangeException
  53     bool isActive(size_t interval) const;
  54
  55     // returns duration of given interval
  56     unsigned long duration(size_t interval) const;
  57
  58   private:
  59     // If true, the sequence starts with haptic action (not pause)
  60     bool m_startsActive;
  61
  62     // A sequence of action/pause intervals
  63     std::vector<unsigned long> m_sequence;
  64 };
  65
  66 typedef DPL::SharedPtr<HapticPattern> HapticPatternPtr;
  67 } // Api
  68 } // Haptics
  69 } // WrtDeviceApis
  70
  71 #endif /* WRTDEVICEAPIS_HAPTIC_HAPTICPATTERN_H_ */