inc/FUixVisionImageFeatureInfo.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2013 Samsung Electronics Co., Ltd.
   4 //
   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
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  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.
  16 //
  17
  18
  19 /**
  20  * @file     FUixVisionImageFeatureInfo.h
  21  * @brief    This is the header file for the %ImageFeatureInfo class.
  22  *
  23  * This header file contains the declarations of the %ImageFeatureInfo class.
  24  */
  25
  26 #ifndef _FUIX_VISION_IMAGE_FEATURE_INFO_H_
  27 #define _FUIX_VISION_IMAGE_FEATURE_INFO_H_
  28
  29 #include <FBaseObject.h>
  30 #include <FGraphics.h>
  31
  32 namespace Tizen { namespace Uix { namespace Vision
  33 {
  34 /**
  35  * @class    ImageFeatureInfo
  36  * @brief    This class holds information of individual image feature data in an image feature set.
  37  *
  38  * @since    2.1
  39  *
  40  * The %ImageFeatureInfo class holds information of individual image feature data in an image feature set.
  41  *
  42  * @see      Tizen::Uix::Vision::ImageFeatureManager
  43  */
  44 class _OSP_EXPORT_ ImageFeatureInfo
  45     : public Tizen::Base::Object
  46 {
  47 public:
  48
  49     /**
  50      * Gets detail description for feature set.
  51      *
  52      * @since       2.1
  53      *
  54      * @return      Detail description for feature set
  55      *
  56      */
  57     Tizen::Base::String GetDescription(void) const;
  58
  59     /**
  60      * Gets width of thumbnail image.
  61      *
  62      * @since       2.1
  63      *
  64      * @return      Thumbnail image width.
  65      *
  66      */
  67     int GetThumbnailWidth(void) const;
  68
  69     /**
  70      * Gets height of thumbnail image.
  71      *
  72      * @since       2.1
  73      *
  74      * @return      Thumbnail image height.
  75      *
  76      * @exception   E_SUCCESS                The method is successful.
  77      */
  78     int GetThumbnailHeight(void) const;
  79
  80     /**
  81      * Gets the thumbnail image by extracting it.
  82      *
  83      * @since       2.1
  84      *
  85      * @return      A pointer to the Tizen::Base::ByteBuffer instance containing the thumbnail image
  86      */
  87     Tizen::Base::ByteBuffer* GetThumbnailN(void) const;
  88
  89     /**
  90      * Compares the calling instance with a specified instance.
  91      *
  92      * @since       2.1
  93      *
  94      * @return      @c true if the specified instance of Tizen::Base::Object is equal to the calling %ImageFeatureInfo instance, @n
  95      *              else @c false
  96      * @param[in]   obj               The object to compare
  97      */
  98     virtual bool Equals(const Tizen::Base::Object& obj) const;
  99
 100     /**
 101      * Gets the hash value of a current instance.
 102      *
 103      * @since        2.1
 104      *
 105      * @return       The hash value of the current instance
 106      */
 107     virtual int GetHashCode(void) const;
 108
 109 private:
 110     /**
 111      * This is the default constructor for this class.
 112      * The implementation of this constructor is declared as private to prohibit construction of the object by user.
 113      *
 114      * @since         2.1
 115      */
 116     ImageFeatureInfo(void);
 117
 118     /**
 119      * This is the destructor for this class. @n
 120      * The resources are deallocated by this method.
 121      * This destructor overrides Tizen::Base::Object::~Object().
 122      *
 123      * @since         2.1
 124      */
 125     ~ImageFeatureInfo(void);
 126     /**
 127      * The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects.
 128      */
 129     ImageFeatureInfo(const ImageFeatureInfo&);
 130
 131     /**
 132      * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
 133      */
 134     ImageFeatureInfo& operator=(const ImageFeatureInfo&);
 135
 136 private:
 137     class _ImageFeatureInfoImpl* __pImageFeatureInfoImpl;
 138     friend class _ImageFeatureInfoImpl;
 139 };
 140
 141 } } } //Tizen::Uix::Vision
 142
 143 #endif /* _FUIX_VISION_IMAGE_FEATURE_INFO_H_ */