(Constant) member iterator for a JSON object value More...
#include <document.h>
Public Types | |
| typedef GenericMemberIterator< true, Encoding, Allocator > | ConstIterator |
| Constant iterator type. | |
| typedef GenericMemberIterator | Iterator |
| Iterator type itself. | |
| typedef GenericMemberIterator< false, Encoding, Allocator > | NonConstIterator |
| Non-constant iterator type. | |
Public Member Functions | |
stepping | |
| Iterator & | operator++ () |
| Iterator & | operator-- () |
| Iterator | operator++ (int) |
| Iterator | operator-- (int) |
increment/decrement | |
| Iterator | operator+ (DifferenceType n) const |
| Iterator | operator- (DifferenceType n) const |
| Iterator & | operator+= (DifferenceType n) |
| Iterator & | operator-= (DifferenceType n) |
relations | |
| template<bool Const_> | |
| bool | operator== (const GenericMemberIterator< Const_, Encoding, Allocator > &that) const |
| template<bool Const_> | |
| bool | operator!= (const GenericMemberIterator< Const_, Encoding, Allocator > &that) const |
| template<bool Const_> | |
| bool | operator<= (const GenericMemberIterator< Const_, Encoding, Allocator > &that) const |
| template<bool Const_> | |
| bool | operator>= (const GenericMemberIterator< Const_, Encoding, Allocator > &that) const |
| template<bool Const_> | |
| bool | operator< (const GenericMemberIterator< Const_, Encoding, Allocator > &that) const |
| template<bool Const_> | |
| bool | operator> (const GenericMemberIterator< Const_, Encoding, Allocator > &that) const |
Friends | |
| class | GenericValue< Encoding, Allocator > |
std::iterator_traits support | |
| typedef ValueType | value_type |
| typedef ValueType * | pointer |
| typedef ValueType & | reference |
| typedef std::ptrdiff_t | difference_type |
| typedef std::random_access_iterator_tag | iterator_category |
| typedef pointer | Pointer |
| Pointer to (const) GenericMember. | |
| typedef reference | Reference |
| Reference to (const) GenericMember. | |
| typedef difference_type | DifferenceType |
Signed integer type (e.g. ptrdiff_t) | |
| GenericMemberIterator () | |
| Default constructor (singular value) | |
| GenericMemberIterator (const NonConstIterator &it) | |
| Iterator conversions to more const. | |
| Iterator & | operator= (const NonConstIterator &it) |
dereference | |
| Reference | operator* () const |
| Pointer | operator-> () const |
| Reference | operator[] (DifferenceType n) const |
| DifferenceType | operator- (ConstIterator that) const |
| Distance. | |
Detailed Description
class GenericMemberIterator< Const, Encoding, Allocator >
(Constant) member iterator for a JSON object value
- Template Parameters
-
Const Is this a constant iterator? Encoding Encoding of the value. (Even non-string values need to have the same encoding in a document) Allocator Allocator type for allocating memory of object, array and string.
This class implements a Random Access Iterator for GenericMember elements of a GenericValue, see ISO/IEC 14882:2003(E) C++ standard, 24.1 [lib.iterator.requirements].
- Note
- This iterator implementation is mainly intended to avoid implicit conversions from iterator values to
NULL, e.g. from GenericValue::FindMember. -
Define
RAPIDJSON_NOMEMBERITERATORCLASSto fall back to a pointer-based implementation, if your platform doesn't provide the C++ <iterator> header.
Definition at line 177 of file document.h.
Member Typedef Documentation
◆ ConstIterator
| typedef GenericMemberIterator<true,Encoding,Allocator> GenericMemberIterator< Const, Encoding, Allocator >::ConstIterator |
Constant iterator type.
Definition at line 189 of file document.h.
◆ difference_type
| typedef std::ptrdiff_t GenericMemberIterator< Const, Encoding, Allocator >::difference_type |
Definition at line 198 of file document.h.
◆ DifferenceType
| typedef difference_type GenericMemberIterator< Const, Encoding, Allocator >::DifferenceType |
Signed integer type (e.g. ptrdiff_t)
Definition at line 207 of file document.h.
◆ Iterator
| typedef GenericMemberIterator GenericMemberIterator< Const, Encoding, Allocator >::Iterator |
Iterator type itself.
Definition at line 187 of file document.h.
◆ iterator_category
| typedef std::random_access_iterator_tag GenericMemberIterator< Const, Encoding, Allocator >::iterator_category |
Definition at line 199 of file document.h.
◆ NonConstIterator
| typedef GenericMemberIterator<false,Encoding,Allocator> GenericMemberIterator< Const, Encoding, Allocator >::NonConstIterator |
Non-constant iterator type.
Definition at line 191 of file document.h.
◆ Pointer
| typedef pointer GenericMemberIterator< Const, Encoding, Allocator >::Pointer |
Pointer to (const) GenericMember.
Definition at line 203 of file document.h.
◆ pointer
| typedef ValueType* GenericMemberIterator< Const, Encoding, Allocator >::pointer |
Definition at line 196 of file document.h.
◆ Reference
| typedef reference GenericMemberIterator< Const, Encoding, Allocator >::Reference |
Reference to (const) GenericMember.
Definition at line 205 of file document.h.
◆ reference
| typedef ValueType& GenericMemberIterator< Const, Encoding, Allocator >::reference |
Definition at line 197 of file document.h.
◆ value_type
| typedef ValueType GenericMemberIterator< Const, Encoding, Allocator >::value_type |
Definition at line 195 of file document.h.
Constructor & Destructor Documentation
◆ GenericMemberIterator() [1/2]
|
inline |
Default constructor (singular value)
Creates an iterator pointing to no element.
- Note
- All operations, except for comparisons, are undefined on such values.
Definition at line 213 of file document.h.
◆ GenericMemberIterator() [2/2]
|
inline |
Iterator conversions to more const.
- Parameters
-
it (Non-const) iterator to copy from
Allows the creation of an iterator from another GenericMemberIterator that is "less const". Especially, creating a non-constant iterator from a constant iterator are disabled:
- const -> non-const (not ok)
- const -> const (ok)
- non-const -> const (ok)
- non-const -> non-const (ok)
- Note
- If the
Consttemplate parameter is alreadyfalse, this constructor effectively defines a regular copy-constructor. Otherwise, the copy constructor is implicitly defined.
Definition at line 231 of file document.h.
Member Function Documentation
◆ operator!=()
|
inline |
Definition at line 254 of file document.h.
◆ operator*()
|
inline |
Definition at line 267 of file document.h.
◆ operator+()
|
inline |
Definition at line 244 of file document.h.
◆ operator++() [1/2]
|
inline |
Definition at line 236 of file document.h.
◆ operator++() [2/2]
|
inline |
Definition at line 238 of file document.h.
◆ operator+=()
|
inline |
Definition at line 247 of file document.h.
◆ operator-() [1/2]
|
inline |
Distance.
Definition at line 273 of file document.h.
◆ operator-() [2/2]
|
inline |
Definition at line 245 of file document.h.
◆ operator--() [1/2]
|
inline |
Definition at line 237 of file document.h.
◆ operator--() [2/2]
|
inline |
Definition at line 239 of file document.h.
◆ operator-=()
|
inline |
Definition at line 248 of file document.h.
◆ operator->()
|
inline |
Definition at line 268 of file document.h.
◆ operator<()
|
inline |
Definition at line 257 of file document.h.
◆ operator<=()
|
inline |
Definition at line 255 of file document.h.
◆ operator=()
|
inline |
Definition at line 232 of file document.h.
◆ operator==()
|
inline |
Definition at line 253 of file document.h.
◆ operator>()
|
inline |
Definition at line 258 of file document.h.
◆ operator>=()
|
inline |
Definition at line 256 of file document.h.
◆ operator[]()
|
inline |
Definition at line 269 of file document.h.
Friends And Related Symbol Documentation
◆ GenericMemberIterator
|
friend |
Definition at line 180 of file document.h.
◆ GenericValue< Encoding, Allocator >
|
friend |
Definition at line 149 of file document.h.
The documentation for this class was generated from the following file:
