Allows for iteration through the members of a dictionary pref, a la std::vector iteration.
More...
#include <hdicoreDictionaryPref.h>
Allows for iteration through the members of a dictionary pref, a la std::vector iteration.
{
}
Allows for iteration through the members of a dictionary pref, a la std::vector iteration.
Definition: hdicoreDictionaryPref.h:76
bool atEnd() const
Determines whether iteration should stop; works well as the conditional in a for() loop.
◆ Iterator()
hdi::core::DictionaryPref::Iterator::Iterator |
( |
const Iterator & |
iter_ | ) |
|
Constructs an Iterator object from an existing Iterator object (copy constructor)
- Author
- GW
- Date
- 09/2014
- Parameters
-
◆ ~Iterator()
hdi::core::DictionaryPref::Iterator::~Iterator |
( |
| ) |
|
Destructs an Iterator object.
- Author
- GW
- Date
- 09/2014
◆ atEnd()
bool hdi::core::DictionaryPref::Iterator::atEnd |
( |
| ) |
const |
Determines whether iteration should stop; works well as the conditional in a for() loop.
- Author
- GW
- Date
- 09/2014
- Returns
- true if at the end of the list of members, false otherwise
◆ key()
std::string hdi::core::DictionaryPref::Iterator::key |
( |
| ) |
const |
Gets the current member's key as pointed to by the iterator.
- Author
- GW
- Date
- 09/2014
- Returns
- The current member's key, or "" if at the end
◆ operator!=()
bool hdi::core::DictionaryPref::Iterator::operator!= |
( |
const Iterator & |
rhs_ | ) |
const |
Tests whether a given Iterator object is not the same as another.
- Author
- GW
- Date
- 09/2014
- Parameters
-
rhs_ | Iterator to compare against (righthand side of inequality operator) |
- Returns
- true for the target and rhs_ having differing states, false otherwise
◆ operator++() [1/2]
Iterator & hdi::core::DictionaryPref::Iterator::operator++ |
( |
| ) |
|
Prefix increment operator for forward iteration.
- Author
- GW
- Date
- 09/2014
- Returns
- A reference to the iterator after its position was changed
◆ operator++() [2/2]
Iterator hdi::core::DictionaryPref::Iterator::operator++ |
( |
int |
| ) |
|
Postfix increment operator for forward iteration.
- Author
- GW
- Date
- 09/2014
- Returns
- A copy of the original iterator before its position was changed
◆ operator--() [1/2]
Iterator & hdi::core::DictionaryPref::Iterator::operator-- |
( |
| ) |
|
Prefix decrement operator for reverse iteration.
- Author
- GW
- Date
- 09/2014
- Returns
- A reference to the iterator after its position was changed
◆ operator--() [2/2]
Iterator hdi::core::DictionaryPref::Iterator::operator-- |
( |
int |
| ) |
|
Postfix decrement operator for reverse iteration.
- Author
- GW
- Date
- 09/2014
- Returns
- A copy of the original iterator before its position was changed
◆ operator=()
Iterator & hdi::core::DictionaryPref::Iterator::operator= |
( |
const Iterator & |
rhs_ | ) |
|
Assigns one Iterator object to another.
- Author
- GW
- Date
- 09/2014
- Parameters
-
rhs_ | Existing Iterator object to copy values from |
- Returns
- The target Iterator object, but with its values updated to match that of the rhs_ argument
◆ operator==()
bool hdi::core::DictionaryPref::Iterator::operator== |
( |
const Iterator & |
rhs_ | ) |
const |
Tests whether a given Iterator object is the same as another.
- Author
- GW
- Date
- 09/2014
- Parameters
-
rhs_ | Iterator to compare against (righthand side of equality operator) |
- Returns
- true for the target and rhs_ having the same state, false otherwise
◆ value()
std::unique_ptr< PrefData > hdi::core::DictionaryPref::Iterator::value |
( |
| ) |
const |
Gets the current member's value as pointed to by the iterator.
- Author
- GW
- Date
- 09/2014
- Returns
- The current member's value, or NULL if at the end