Read-only iteration for nom::Value. More...

#include <ValueConstIterator.hpp>

Inheritance diagram for nom::ValueConstIterator:

Public Types
typedef ValueConstIterator	SelfType
typedef ValueIteratorBase	DerivedType
typedef SelfType *	RawPtr
typedef SelfType &	Reference
typedef ValueIteratorBase::ValueTypeReference	ConstReference
typedef SelfType	ConstIterator
Public Types inherited from nom::ValueIteratorBase
enum	IteratorType { Null = 0 , ObjectValues }
typedef ValueIteratorBase	SelfType
typedef ValueIteratorBase *	RawPtr
typedef nom::size_type	DifferenceType
typedef Value &	ValueTypeReference
typedef Value *	ValueTypePointer

Public Member Functions
	ValueConstIterator ()
	Default constructor.
	~ValueConstIterator ()
	Destructor.
	ValueConstIterator (const ValueConstIterator &rhs)
	Copy constructor.
	ValueConstIterator (const ObjectIterator &rhs)
	Copy constructor.
SelfType &	operator= (const DerivedType &rhs)
const Value::RawPtr	operator-> () const
	Obtain a pointer to the iterator's object.
ConstReference	operator* () const
	Obtain a reference to the iterator's object.
SelfType &	operator++ ()
	Increment the object by one.
SelfType	operator++ (int)
	Increment by specified parameter.
SelfType &	operator-- ()
	Decrement by one.
SelfType	operator-- (int)
	Decrement by specified parameter.
Public Member Functions inherited from nom::ValueIteratorBase
	ValueIteratorBase ()
	Default constructor.
virtual	~ValueIteratorBase ()
	Destructor.
	ValueIteratorBase (const ObjectIterator &rhs)
bool	valid () const
	query validity of the object.
ArrayIndex	index () const
	Obtain the index of the referenced value.
const char *	key () const
	Obtain the current index or member key value.
bool	key (const std::string &member) const
	Query if the member key exists at the current position of the iterator object.
bool	operator== (const SelfType &rhs) const
bool	operator!= (const SelfType &rhs) const
DifferenceType	operator- (const SelfType &rhs) const

Additional Inherited Members
Protected Member Functions inherited from nom::ValueIteratorBase
void	copy (const SelfType &rhs)
ValueTypeReference	dereference () const
ValueTypePointer	pointer () const
void	increment ()
void	decrement ()
DifferenceType	distance (const SelfType &rhs) const

Detailed Description

Read-only iteration for nom::Value.

Todo: Finish implementation.

Definition at line 42 of file ValueConstIterator.hpp.

Member Typedef Documentation

◆ ConstIterator

typedef SelfType nom::ValueConstIterator::ConstIterator

Definition at line 52 of file ValueConstIterator.hpp.

◆ ConstReference

typedef ValueIteratorBase::ValueTypeReference nom::ValueConstIterator::ConstReference

Definition at line 51 of file ValueConstIterator.hpp.

◆ DerivedType

typedef ValueIteratorBase nom::ValueConstIterator::DerivedType

Definition at line 46 of file ValueConstIterator.hpp.

◆ RawPtr

typedef SelfType* nom::ValueConstIterator::RawPtr

Definition at line 48 of file ValueConstIterator.hpp.

◆ Reference

typedef SelfType& nom::ValueConstIterator::Reference

Definition at line 49 of file ValueConstIterator.hpp.

◆ SelfType

typedef ValueConstIterator nom::ValueConstIterator::SelfType

Definition at line 45 of file ValueConstIterator.hpp.

Member Function Documentation

◆ operator*()

ConstReference nom::ValueConstIterator::operator* ( ) const

Obtain a reference to the iterator's object.

Returns: A reference to the nom::Value object.

◆ operator++() [1/2]

SelfType & nom::ValueConstIterator::operator++ ( )

Increment the object by one.

Remarks: The object is not modified.

◆ operator++() [2/2]

SelfType nom::ValueConstIterator::operator++ ( int )

Increment by specified parameter.

Remarks: The object is not modified.

◆ operator--() [1/2]

SelfType & nom::ValueConstIterator::operator-- ( )

Decrement by one.

Remarks: The object is not modified.

◆ operator--() [2/2]

SelfType nom::ValueConstIterator::operator-- ( int )

Decrement by specified parameter.

Remarks: The object is not modified.

◆ operator->()

const Value::RawPtr nom::ValueConstIterator::operator-> ( ) const

Obtain a pointer to the iterator's object.

Returns: A pointer to the nom::Value object.

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

/home/jeff/Projects/nomlib.git/include/nomlib/ptree/ValueConstIterator.hpp

Public Types

Public Member Functions

Additional Inherited Members