dali/public-api/object/property-array.h

   1 #ifndef __DALI_PROPERTY_ARRAY_H__
   2 #define __DALI_PROPERTY_ARRAY_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <string>
  23
  24 // INTERNAL INCLUDES
  25 #include <dali/public-api/common/dali-common.h>
  26 #include <dali/public-api/object/property-value.h>
  27 #include <dali/public-api/object/property.h>
  28
  29 namespace Dali
  30 {
  31 /**
  32  * @addtogroup dali_core_object
  33  * @{
  34  */
  35
  36 /**
  37  * @brief A Array of property values.
  38  * @SINCE_1_0.0
  39  */
  40 class DALI_IMPORT_API Property::Array
  41 {
  42 public:
  43
  44   typedef std::size_t SizeType;
  45
  46   /**
  47    * @brief Default constructor.
  48    * @SINCE_1_0.0
  49    */
  50   Array();
  51
  52   /**
  53    * @brief Copy Constructor.
  54    *
  55    * @SINCE_1_0.0
  56    * @param[in] other The Array to copy from.
  57    */
  58   Array( const Array& other );
  59
  60   /**
  61    * @brief Non-virtual destructor.
  62    * @SINCE_1_0.0
  63    */
  64   ~Array();
  65
  66   /**
  67    * @brief Retrieve the number of elements in the array.
  68    *
  69    * @SINCE_1_0.0
  70    * @return The number of elements in the array.
  71    */
  72   SizeType Size() const
  73   {
  74     return Count();
  75   }
  76
  77   /**
  78    * @brief Retrieve the number of elements in the array.
  79    *
  80    * @SINCE_1_0.0
  81    * @return The number of elements in the array.
  82    */
  83   SizeType Count() const;
  84
  85   /**
  86    * @brief Returns whether the array is empty.
  87    *
  88    * @SINCE_1_0.0
  89    * @return true if empty, false otherwise
  90    */
  91   bool Empty() const
  92   {
  93     return Count() == 0;
  94   }
  95
  96   /**
  97    * @brief Clears the array.
  98    * @SINCE_1_0.0
  99    */
 100   void Clear();
 101
 102   /**
 103    * @brief Increase the capcity of the array.
 104    * @SINCE_1_0.0
 105    * @param[in] size The size to reserve
 106    */
 107   void Reserve( SizeType size );
 108
 109   /**
 110    * @brief Resize to size.
 111    * @SINCE_1_0.0
 112    * @param[in] size The size to resize
 113    */
 114   void Resize( SizeType size );
 115
 116   /**
 117    * @brief Retrieve the capacity of the array.
 118    *
 119    * @SINCE_1_0.0
 120    * @return The allocated capacity of the array
 121    */
 122   SizeType Capacity();
 123
 124   /**
 125    * @brief Add an element to the array.
 126    *
 127    * @SINCE_1_0.0
 128    * @param[in] value The value to add to the end of the array
 129    */
 130   void PushBack( const Value& value );
 131
 132   /**
 133    * @brief Add an element to the array.
 134    *
 135    * @SINCE_1_2.11
 136    * @param[in] value The value to add to the end of the array
 137    */
 138   inline Property::Array& Add( const Value& value )
 139   {
 140     PushBack( value );
 141     return *this;
 142   }
 143
 144   /**
 145    * @brief Const access an element.
 146    *
 147    * @SINCE_1_0.0
 148    * @param[in] index The element index to access. No bounds checking is performed.
 149    *
 150    * @return The a reference to the element.
 151    */
 152   const Value& GetElementAt( SizeType index ) const
 153   {
 154     return operator[]( index );
 155   }
 156
 157   /**
 158    * @brief Access an element.
 159    *
 160    * @SINCE_1_0.0
 161    * @param[in] index The element index to access. No bounds checking is performed.
 162    *
 163    * @return The a reference to the element.
 164    */
 165   Value& GetElementAt( SizeType index )
 166   {
 167     return operator[]( index );
 168   }
 169
 170   /**
 171    * @brief Const operator to access an element.
 172    *
 173    * @SINCE_1_0.0
 174    * @param[in] index The element index to access. No bounds checking is performed.
 175    *
 176    * @return The a reference to the element.
 177    *
 178    */
 179   const Value& operator[]( SizeType index ) const;
 180
 181   /**
 182    * @brief Operator to access an element.
 183    *
 184    * @SINCE_1_0.0
 185    * @param[in] index The element index to access. No bounds checking is performed.
 186    *
 187    * @return The a reference to the element.
 188    *
 189    */
 190   Value& operator[]( SizeType index );
 191
 192   /**
 193    * @brief Assignment Operator
 194    *
 195    * @SINCE_1_0.0
 196    * @param[in] other The array to copy from.
 197    *
 198    * @return The copied array.
 199    */
 200   Array& operator=( const Array& other );
 201
 202   /**
 203    * @brief output to stream
 204    * @SINCE_1_1.28
 205    */
 206   friend std::ostream& operator<<( std::ostream& stream, const Property::Array& array );
 207
 208 private:
 209   struct DALI_INTERNAL Impl; ///< Private data
 210   Impl* mImpl; ///< Pointer to private data
 211 };
 212
 213 /**
 214  * @brief Convert the values of the property array into a string and append to an output stream.
 215  *
 216  * @SINCE_1_1.28
 217  * @param [in] stream The output stream operator.
 218  * @param [in] array The array to insert
 219  * @return The output stream operator.
 220  */
 221 DALI_IMPORT_API std::ostream& operator<<( std::ostream& stream, const Property::Array& array );
 222
 223 /**
 224  * @}
 225  */
 226 } // namespace Dali
 227
 228 #endif // __DALI_PROPERTY_ARRAY_H__