#include <emetaarray.h>
Public Member Functions | |
| EMetaArray & | operator= (const EMetaArray &object) |
| EMetadata & | operator[] (int index) |
| const EMetadata & | operator[] (int index) const |
| EMetaArray & | operator<< (const EMetadata &value) |
| bool | isEmpty () const |
| int | size () const |
| QList< EMetadata >::iterator | begin () |
| QList< EMetadata >::const_iterator | begin () const |
| QList< EMetadata >::const_iterator | cbegin () const |
| QList< EMetadata >::iterator | end () |
| QList< EMetadata >::const_iterator | end () const |
| QList< EMetadata >::const_iterator | cend () const |
| const EMetadata & | at (int index) const |
| void | insert (int index, const EMetadata &value) |
| void | append (const EMetadata &value) |
| void | clear () |
Detailed Description
This holds a list of metadata objects. It inherits from Qt so it is copy on write. Refer to EMetadata for more information about the metadata system.
Member Function Documentation
◆ append()
| void EMetaArray::append | ( | const EMetadata & | value | ) |
Appends a new metadata value to the end of the array.
- Parameters
-
value The new metadata value to be appended to the end of the array.
◆ at()
| const EMetadata & EMetaArray::at | ( | int | index | ) | const |
Returns constant reference to metadata object with given index within the array of metadata objects. If the index is beyond the scope of the array then Qt will force exit the program.
- Parameters
-
index Index of requested metadata object within the array of objects.
- Returns
- Reference to metadata object with given index.
◆ begin() [1/2]
| QList< EMetadata >::iterator EMetaArray::begin | ( | ) |
Returns iterator to first metadata item in the array.
- Returns
- First metadata iterator.
◆ begin() [2/2]
| QList< EMetadata >::const_iterator EMetaArray::begin | ( | ) | const |
Returns constant iterator to first metadata object in the array.
- Returns
- First metadata constant iterator.
◆ cbegin()
| QList< EMetadata >::const_iterator EMetaArray::cbegin | ( | ) | const |
Returns constant iterator to first metadata object in the array.
- Returns
- First metadata constant iterator.
◆ cend()
| QList< EMetadata >::const_iterator EMetaArray::cend | ( | ) | const |
Returns end of array constant iterator.
- Returns
- End of array constant iterator.
◆ clear()
| void EMetaArray::clear | ( | ) |
Deletes all metadata values from the array making it an empty array.
◆ end() [1/2]
| QList< EMetadata >::iterator EMetaArray::end | ( | ) |
Returns end of array iterator.
- Returns
- End of array iterator.
◆ end() [2/2]
| QList< EMetadata >::const_iterator EMetaArray::end | ( | ) | const |
Returns end of array constant iterator.
- Returns
- End of array constant iterator.
◆ insert()
| void EMetaArray::insert | ( | int | index, |
| const EMetadata & | value | ||
| ) |
Inserts a new metadata value to the array at the given index of the array. If the index is less than or equal to 0 it is prepended to the array. If the index is greater than or equal to the size of the array it is appended to the list.
- Parameters
-
index Index where new metadata value will be inserted. value The new metadata value to be inserted into the array.
◆ isEmpty()
| bool EMetaArray::isEmpty | ( | ) | const |
Tests if the array is empty or not.
- Returns
- Returns true of the array is empty else returns false.
◆ operator<<()
| EMetaArray & EMetaArray::operator<< | ( | const EMetadata & | value | ) |
Appends a new metadata value to the end of the array.
- Parameters
-
value The new metadata value to be appended to the end of the array.
- Returns
- Reference to this object.
◆ operator=()
| EMetaArray & EMetaArray::operator= | ( | const EMetaArray & | object | ) |
Assign this array to the one given. The array will not be copied until a write operation is performed.
- Parameters
-
object Array that this object will be assigned to.
- Returns
- Reference to this object.
◆ operator[]() [1/2]
| EMetadata & EMetaArray::operator[] | ( | int | index | ) |
Returns reference to metadata object with the given index. If the index is out of range of the array then Qt will force exit the program.
- Parameters
-
index Index of requested metadata object within the array.
- Returns
- Reference to metadata object.
◆ operator[]() [2/2]
| const EMetadata & EMetaArray::operator[] | ( | int | index | ) | const |
Returns constant reference to metadata object with the given index. If the index is out of range of the array then Qt will force exit the program.
- Parameters
-
index Index of requested metadata object within the array.
- Returns
- Constant reference to metadata object.
◆ size()
| int EMetaArray::size | ( | ) | const |
Gets the size of the array.
- Returns
- Size of the array.
The documentation for this class was generated from the following files:
- emetaarray.h
- emetaarray.cpp
