GroupIterator Class Reference
Iterates over an instance of Groups. More...
#include <Groups.hpp>
Public Member Functions | |
| GroupIterator (const Groups &groups) | |
| Creates an iterator over all groups. | |
| GroupIterator (const Groups &groups, HexColorSet colorset) | |
| Creates an iterator over only those groups in colorset. | |
| GroupIterator (const Groups &groups, HexColor color) | |
| Creates an iterator over only those groups of color. | |
| const Group & | operator* () const |
| Returns current group. | |
| const Group * | operator-> () const |
| Allows access to current group's methods. | |
| void | operator++ () |
| Moves to the next group. | |
| bool | boolean_test () const |
| Used by SafeBool. | |
| operator bool_type () const | |
Protected Types | |
| typedef void(SafeBool::* | bool_type )() const |
Protected Member Functions | |
| void | this_type_does_not_support_comparisons () const |
Private Member Functions | |
| void | FindNextInColorSet () |
Private Attributes | |
| const Groups * | m_groups |
| HexColorSet | m_colorset |
| std::size_t | m_index |
Detailed Description
Iterates over an instance of Groups.
Definition at line 315 of file Groups.hpp.
Member Typedef Documentation
typedef void(SafeBool::* SafeBool< GroupIterator >::bool_type)() const [protected, inherited] |
Definition at line 22 of file SafeBool.hpp.
Constructor & Destructor Documentation
| GroupIterator::GroupIterator | ( | const Groups & | groups | ) | [inline] |
Creates an iterator over all groups.
Definition at line 351 of file Groups.hpp.
| GroupIterator::GroupIterator | ( | const Groups & | groups, | |
| HexColorSet | colorset | |||
| ) | [inline] |
Creates an iterator over only those groups in colorset.
Definition at line 358 of file Groups.hpp.
References FindNextInColorSet().
Creates an iterator over only those groups of color.
Definition at line 366 of file Groups.hpp.
References FindNextInColorSet().
Member Function Documentation
| bool GroupIterator::boolean_test | ( | ) | const [inline] |
Used by SafeBool.
Definition at line 398 of file Groups.hpp.
References Groups::m_groups, m_groups, and m_index.
| void GroupIterator::FindNextInColorSet | ( | ) | [inline, private] |
Definition at line 390 of file Groups.hpp.
References HexColorSetUtil::InSet(), m_colorset, Groups::m_groups, m_groups, and m_index.
Referenced by GroupIterator(), and operator++().
| SafeBool< GroupIterator >::operator bool_type | ( | ) | const [inline, inherited] |
Definition at line 26 of file SafeBool.hpp.
References SafeBool< T >::this_type_does_not_support_comparisons().
| const Group & GroupIterator::operator* | ( | ) | const [inline] |
Returns current group.
Definition at line 374 of file Groups.hpp.
References Groups::m_groups, m_groups, and m_index.
| void GroupIterator::operator++ | ( | ) | [inline] |
Moves to the next group.
Definition at line 384 of file Groups.hpp.
References FindNextInColorSet(), and m_index.
| const Group * GroupIterator::operator-> | ( | ) | const [inline] |
Allows access to current group's methods.
Definition at line 379 of file Groups.hpp.
References Groups::m_groups, m_groups, and m_index.
| void SafeBool< GroupIterator >::this_type_does_not_support_comparisons | ( | ) | const [inline, protected, inherited] |
Definition at line 23 of file SafeBool.hpp.
Member Data Documentation
HexColorSet GroupIterator::m_colorset [private] |
Definition at line 344 of file Groups.hpp.
Referenced by FindNextInColorSet().
const Groups* GroupIterator::m_groups [private] |
Definition at line 342 of file Groups.hpp.
Referenced by boolean_test(), FindNextInColorSet(), operator*(), and operator->().
std::size_t GroupIterator::m_index [private] |
Definition at line 346 of file Groups.hpp.
Referenced by boolean_test(), FindNextInColorSet(), operator*(), operator++(), and operator->().
The documentation for this class was generated from the following file: