(Constant) member iterator for a JSON object value More...

#include <document.h>

Public Types
typedef GenericMemberIterator< true, Encoding, Allocator >	ConstIterator
	Constant iterator type. More...

typedef difference_type	DifferenceType
	Signed integer type (e.g. `ptrdiff_t`) More...

typedef GenericMemberIterator	Iterator
	Iterator type itself. More...

typedef GenericMemberIterator< false, Encoding, Allocator >	NonConstIterator
	Non-constant iterator type. More...

typedef pointer	Pointer
	Pointer to (const) GenericMember. More...

typedef reference	Reference
	Reference to (const) GenericMember. More...

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

Public Member Functions
	GenericMemberIterator ()
	Default constructor (singular value) More...

	GenericMemberIterator (const NonConstIterator &it)
	Iterator conversions to more const. More...

DifferenceType	operator- (ConstIterator that) const
	Distance. More...

Iterator &	operator= (const NonConstIterator &it)

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
bool	operator== (ConstIterator that) const

bool	operator!= (ConstIterator that) const

bool	operator<= (ConstIterator that) const

bool	operator>= (ConstIterator that) const

bool	operator< (ConstIterator that) const

bool	operator> (ConstIterator that) const

dereference
Reference	operator* () const

Pointer	operator-> () const

Reference	operator[] (DifferenceType n) const

Private Types
typedef GenericMember< Encoding, Allocator >	PlainType

typedef internal::MaybeAddConst< Const, PlainType >::Type	ValueType

Private Member Functions
	GenericMemberIterator (Pointer p)
	Internal constructor from plain pointer. More...

Private Attributes
Pointer	ptr_
	raw pointer More...

Friends
template<bool , typename , typename >
class	GenericMemberIterator

class	GenericValue< Encoding, Allocator >

Detailed Description

template<bool Const, typename Encoding, typename Allocator>
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_NOMEMBERITERATORCLASS to fall back to a pointer-based implementation, if your platform doesn't provide the C++ <iterator> header.

See also: GenericMember, GenericValue::MemberIterator, GenericValue::ConstMemberIterator

Definition at line 142 of file document.h.

Member Typedef Documentation

template<bool Const, typename Encoding , typename Allocator >

typedef GenericMemberIterator<true, Encoding, Allocator> GenericMemberIterator< Const, Encoding, Allocator >::ConstIterator

Constant iterator type.

Definition at line 154 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef std::ptrdiff_t GenericMemberIterator< Const, Encoding, Allocator >::difference_type

Definition at line 163 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef difference_type GenericMemberIterator< Const, Encoding, Allocator >::DifferenceType

Signed integer type (e.g. ptrdiff_t)

Definition at line 172 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef GenericMemberIterator GenericMemberIterator< Const, Encoding, Allocator >::Iterator

Iterator type itself.

Definition at line 152 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef std::random_access_iterator_tag GenericMemberIterator< Const, Encoding, Allocator >::iterator_category

Definition at line 164 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef GenericMemberIterator<false, Encoding, Allocator> GenericMemberIterator< Const, Encoding, Allocator >::NonConstIterator

Non-constant iterator type.

Definition at line 156 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef GenericMember<Encoding, Allocator> GenericMemberIterator< Const, Encoding, Allocator >::PlainType

private

Definition at line 147 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef ValueType* GenericMemberIterator< Const, Encoding, Allocator >::pointer

Definition at line 161 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef pointer GenericMemberIterator< Const, Encoding, Allocator >::Pointer

Pointer to (const) GenericMember.

Definition at line 168 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef ValueType& GenericMemberIterator< Const, Encoding, Allocator >::reference

Definition at line 162 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef reference GenericMemberIterator< Const, Encoding, Allocator >::Reference

Reference to (const) GenericMember.

Definition at line 170 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef ValueType GenericMemberIterator< Const, Encoding, Allocator >::value_type

Definition at line 160 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

typedef internal::MaybeAddConst<Const, PlainType>::Type GenericMemberIterator< Const, Encoding, Allocator >::ValueType

private

Definition at line 148 of file document.h.

Constructor & Destructor Documentation

template<bool Const, typename Encoding , typename Allocator >

GenericMemberIterator< Const, Encoding, Allocator >::GenericMemberIterator ( )

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 179 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

GenericMemberIterator< Const, Encoding, Allocator >::GenericMemberIterator ( const NonConstIterator & it )

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 Const template parameter is already false, this constructor effectively defines a regular copy-constructor. Otherwise, the copy constructor is implicitly defined.

Definition at line 197 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

GenericMemberIterator< Const, Encoding, Allocator >::GenericMemberIterator ( Pointer p )

inlineexplicitprivate

Internal constructor from plain pointer.

Definition at line 264 of file document.h.

Member Function Documentation

template<bool Const, typename Encoding , typename Allocator >

bool GenericMemberIterator< Const, Encoding, Allocator >::operator!= ( ConstIterator that ) const

inline

Definition at line 243 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Reference GenericMemberIterator< Const, Encoding, Allocator >::operator* ( ) const

inline

Definition at line 252 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Iterator GenericMemberIterator< Const, Encoding, Allocator >::operator+ ( DifferenceType n ) const

inline

Definition at line 227 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Iterator& GenericMemberIterator< Const, Encoding, Allocator >::operator++ ( )

inline

Definition at line 205 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Iterator GenericMemberIterator< Const, Encoding, Allocator >::operator++ ( int )

inline

Definition at line 213 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Iterator& GenericMemberIterator< Const, Encoding, Allocator >::operator+= ( DifferenceType n )

inline

Definition at line 230 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Iterator GenericMemberIterator< Const, Encoding, Allocator >::operator- ( DifferenceType n ) const

inline

Definition at line 228 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

DifferenceType GenericMemberIterator< Const, Encoding, Allocator >::operator- ( ConstIterator that ) const

inline

Distance.

Definition at line 258 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Iterator& GenericMemberIterator< Const, Encoding, Allocator >::operator-- ( )

inline

Definition at line 209 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Iterator GenericMemberIterator< Const, Encoding, Allocator >::operator-- ( int )

inline

Definition at line 218 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Iterator& GenericMemberIterator< Const, Encoding, Allocator >::operator-= ( DifferenceType n )

inline

Definition at line 234 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Pointer GenericMemberIterator< Const, Encoding, Allocator >::operator-> ( ) const

inline

Definition at line 253 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

bool GenericMemberIterator< Const, Encoding, Allocator >::operator< ( ConstIterator that ) const

inline

Definition at line 246 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

bool GenericMemberIterator< Const, Encoding, Allocator >::operator<= ( ConstIterator that ) const

inline

Definition at line 244 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Iterator& GenericMemberIterator< Const, Encoding, Allocator >::operator= ( const NonConstIterator & it )

inline

Definition at line 198 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

bool GenericMemberIterator< Const, Encoding, Allocator >::operator== ( ConstIterator that ) const

inline

Definition at line 242 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

bool GenericMemberIterator< Const, Encoding, Allocator >::operator> ( ConstIterator that ) const

inline

Definition at line 247 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

bool GenericMemberIterator< Const, Encoding, Allocator >::operator>= ( ConstIterator that ) const

inline

Definition at line 245 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

Reference GenericMemberIterator< Const, Encoding, Allocator >::operator[] ( DifferenceType n ) const

inline

Definition at line 254 of file document.h.

Friends And Related Function Documentation

template<bool Const, typename Encoding , typename Allocator >

template<bool , typename , typename >

friend class GenericMemberIterator

friend

Definition at line 145 of file document.h.

template<bool Const, typename Encoding , typename Allocator >

friend class GenericValue< Encoding, Allocator >

friend

Definition at line 143 of file document.h.

Member Data Documentation

template<bool Const, typename Encoding , typename Allocator >

Pointer GenericMemberIterator< Const, Encoding, Allocator >::ptr_

private

raw pointer

Definition at line 266 of file document.h.

The documentation for this class was generated from the following file:

document.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

template<bool Const, typename Encoding, typename Allocator> class GenericMemberIterator< Const, Encoding, Allocator >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<bool Const, typename Encoding, typename Allocator>
class GenericMemberIterator< Const, Encoding, Allocator >