A Array of property values. More...
Public Member Functions | |
Array () | |
Default constructor. | |
Array (const Array &other) | |
Copy Constructor. | |
~Array () | |
Non-virtual destructor. | |
SizeType | Size () const |
Retrieves the number of elements in the array. | |
SizeType | Count () const |
Retrieves the number of elements in the array. | |
bool | Empty () const |
Returns whether the array is empty. | |
void | Clear () |
Clears the array. | |
void | Reserve (SizeType size) |
Increases the capacity of the array. | |
void | Resize (SizeType size) |
Resizes to size. | |
SizeType | Capacity () |
Retrieves the capacity of the array. | |
void | PushBack (const Value &value) |
Adds an element to the array. | |
Property::Array & | Add (const Value &value) |
Add an element to the array. | |
const Value & | GetElementAt (SizeType index) const |
Const access an element. | |
Value & | GetElementAt (SizeType index) |
Accesses an element. | |
const Value & | operator[] (SizeType index) const |
Const operator to access an element. | |
Value & | operator[] (SizeType index) |
Operator to access an element. | |
Array & | operator= (const Array &other) |
Assignment Operator. | |
Friends | |
std::ostream & | operator<< (std::ostream &stream, const Property::Array &array) |
Output to stream. |
Detailed Description
A Array of property values.
- Since:
- 2.4, DALi version 1.0.0
Constructor & Destructor Documentation
Default constructor.
- Since:
- 2.4, DALi version 1.0.0
Dali::Property::Array::Array | ( | const Array & | other | ) |
Non-virtual destructor.
- Since:
- 2.4, DALi version 1.0.0
Member Function Documentation
Property::Array& Dali::Property::Array::Add | ( | const Value & | value | ) |
Add an element to the array.
- Since:
- 4.0, DALi version 1.2.11
- Parameters:
-
[in] value The value to add to the end of the array
- Returns:
- A reference to this object
SizeType Dali::Property::Array::Capacity | ( | ) |
Retrieves the capacity of the array.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- The allocated capacity of the array
void Dali::Property::Array::Clear | ( | ) |
Clears the array.
- Since:
- 2.4, DALi version 1.0.0
SizeType Dali::Property::Array::Count | ( | ) | const |
Retrieves the number of elements in the array.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- The number of elements in the array
bool Dali::Property::Array::Empty | ( | ) | const |
Returns whether the array is empty.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
true
if empty,false
otherwise
const Value& Dali::Property::Array::GetElementAt | ( | SizeType | index | ) | const |
Const access an element.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] index The element index to access. No bounds checking is performed
- Returns:
- The a reference to the element
Value& Dali::Property::Array::GetElementAt | ( | SizeType | index | ) |
Accesses an element.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] index The element index to access. No bounds checking is performed
- Returns:
- The a reference to the element
Assignment Operator.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] other The array to copy from
- Returns:
- The copied array.
const Value& Dali::Property::Array::operator[] | ( | SizeType | index | ) | const |
Const operator to access an element.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] index The element index to access. No bounds checking is performed
- Returns:
- The a reference to the element
Value& Dali::Property::Array::operator[] | ( | SizeType | index | ) |
Operator to access an element.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] index The element index to access. No bounds checking is performed
- Returns:
- The a reference to the element
void Dali::Property::Array::PushBack | ( | const Value & | value | ) |
Adds an element to the array.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] value The value to add to the end of the array
void Dali::Property::Array::Reserve | ( | SizeType | size | ) |
Increases the capacity of the array.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] size The size to reserve
void Dali::Property::Array::Resize | ( | SizeType | size | ) |
Resizes to size.
- Since:
- 2.4, DALi version 1.0.0
- Parameters:
-
[in] size The size to resize
SizeType Dali::Property::Array::Size | ( | ) | const |
Retrieves the number of elements in the array.
- Since:
- 2.4, DALi version 1.0.0
- Returns:
- The number of elements in the array
Friends And Related Function Documentation
std::ostream& operator<< | ( | std::ostream & | stream, |
const Property::Array & | array | ||
) | [friend] |
Output to stream.
- Since:
- 3.0, DALi version 1.1.28
- Since:
- 3.0, DALi version 1.1.28
- Parameters:
-
[in] stream The output stream operator [in] array The array to insert
- Returns:
- The output stream operator