inc/FBaseDoubleComparer.h

   1 //
   2 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   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  * @file                FBaseDoubleComparer.h
  19  * @brief               This is the header file for the %DoubleComparer class.
  20  *
  21  * This header file contains the declarations of the %DoubleComparer class.
  22  *
  23  * @see                 Tizen::Base::Double
  24  * @see                 Tizen::Base::Collection::IComparer
  25  */
  26 #ifndef _FBASE_DOUBLE_COMPARER_H_
  27 #define _FBASE_DOUBLE_COMPARER_H_
  28
  29 #include <FBaseObject.h>
  30 #include <FBaseColIComparer.h>
  31
  32 namespace Tizen { namespace Base
  33 {
  34 /**
  35  *      @class  DoubleComparer
  36  *      @brief  This class checks for equivalence between two instances of the %Double type.
  37  *
  38  *      @since 2.0
  39  *
  40  *      The %DoubleComparer class checks for equivalence between two instances of the Double type.
  41  *
  42  *  For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/base/collection_comparison.htm">Collection Comparisons</a>.
  43  *
  44  *  The following example demonstrates how to use the %DoubleComparer class.
  45  *
  46  *      @code
  47  *
  48  *      #include <FBase.h>
  49  *
  50  *      using namespace Tizen::Base;
  51  *
  52  *      void
  53  *      MyClass::DoubleComparerSample(void)
  54  *      {
  55  *              Double d1(123);
  56  *              Double d2(124);
  57  *              DoubleComparer comparer;
  58  *
  59  *              // Compare 2 instances of Double
  60  *              int cmp;
  61  *              comparer.Compare(d1, d2, cmp);
  62  *              if (cmp < 0)
  63  *              {
  64  *                      // ...
  65  *              }
  66  *      }
  67  *      @endcode
  68  */
  69 class _OSP_EXPORT_ DoubleComparer
  70         : public Object
  71         , public virtual Tizen::Base::Collection::IComparer
  72 {
  73 public:
  74         /**
  75          * This is the default constructor for this class.
  76          *
  77          * @since 2.0
  78          */
  79         DoubleComparer(void);
  80
  81         /**
  82          * This destructor overrides Tizen::Base::Object::~Object().
  83          *
  84          * @since 2.0
  85          */
  86         virtual ~DoubleComparer(void);
  87
  88         /**
  89          *      Compares two given instances of type Double.
  90          *
  91          *      @since 2.0
  92          *
  93          *      @return         An error code
  94          *      @param[in]      obj1                    The first instance of type Double
  95          *      @param[in]      obj2                    The second instance of type Double
  96          *      @param[out] cmp                         The result of the comparison
  97          *  @exception  E_SUCCESS               The method is successful.
  98          *  @exception  E_INVALID_ARG   The specified object instances are not of the expected type.
  99          *  @remarks    The value of @c cmp can be:
 100          *
 101          *      @code
 102          *      <  0  if the value of obj1 is less than the value of obj2
 103          *      == 0  if the value of obj1 is equal to the value of obj2
 104          *      >  0  if the value of obj1 is greater than the value of obj2
 105          *      @endcode
 106          */
 107         virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const;
 108
 109 private:
 110         /**
 111          * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 112          */
 113         DoubleComparer(const DoubleComparer& obj);
 114
 115         /**
 116          * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 117          */
 118         DoubleComparer& operator =(const DoubleComparer& rhs);
 119
 120         friend class _DoubleComparerImpl;
 121         class _DoubleComparerImpl* __pDoubleComparerImpl;
 122
 123 }; // DoubleComparer
 124 }} // Tizen::Base
 125 #endif // _FBASE_DOUBLE_COMPARER_H_