BaseLib::ConfigTree::ValueIterator< ValueType > Class Template Reference

Detailed Description

template<typename ValueType>
class BaseLib::ConfigTree::ValueIterator< ValueType >

A wrapper around a Boost Iterator for iterating over ranges of values.

The methods of this class tell the associated (parent) ConfigTree object when a setting has been parsed.

Definition at line 200 of file ConfigTree.h.

#include <ConfigTree.h>

Collaboration diagram for BaseLib::ConfigTree::ValueIterator< ValueType >:

Public Types
using	iterator_category = std::input_iterator_tag
using	value_type = ConfigTree
using	difference_type = std::ptrdiff_t
using	pointer = ConfigTree*
using	reference = ConfigTree&
using	Iterator = boost::property_tree::ptree::const_assoc_iterator

Public Member Functions
	ValueIterator (Iterator const &it, std::string const &root, ConfigTree const &parent)
ValueIterator< ValueType > &	operator++ ()
ValueType	operator* ()
bool	operator== (ValueIterator< ValueType > const &other) const
bool	operator!= (ValueIterator< ValueType > const &other) const

Private Attributes
bool	has_incremented_ = true
Iterator	it_
std::string const	tagname_
ConfigTree const &	parent_

Member Typedef Documentation

difference_type

template<typename ValueType >

using BaseLib::ConfigTree::ValueIterator< ValueType >::difference_type = std::ptrdiff_t

Definition at line 205 of file ConfigTree.h.

Iterator

template<typename ValueType >

using BaseLib::ConfigTree::ValueIterator< ValueType >::Iterator = boost::property_tree::ptree::const_assoc_iterator

Definition at line 209 of file ConfigTree.h.

iterator_category

template<typename ValueType >

using BaseLib::ConfigTree::ValueIterator< ValueType >::iterator_category = std::input_iterator_tag

Definition at line 203 of file ConfigTree.h.

pointer

template<typename ValueType >

using BaseLib::ConfigTree::ValueIterator< ValueType >::pointer = ConfigTree*

Definition at line 206 of file ConfigTree.h.

reference

template<typename ValueType >

using BaseLib::ConfigTree::ValueIterator< ValueType >::reference = ConfigTree&

Definition at line 207 of file ConfigTree.h.

value_type

template<typename ValueType >

using BaseLib::ConfigTree::ValueIterator< ValueType >::value_type = ConfigTree

Definition at line 204 of file ConfigTree.h.

Constructor & Destructor Documentation

ValueIterator()

template<typename ValueType >

BaseLib::ConfigTree::ValueIterator< ValueType >::ValueIterator ( Iterator const & it, std::string const & root, ConfigTree const & parent )

inlineexplicit

Definition at line 211 of file ConfigTree.h.

            : it_(it), tagname_(root), parent_(parent)
        {
        }

Member Function Documentation

operator!=()

template<typename ValueType >

bool BaseLib::ConfigTree::ValueIterator< ValueType >::operator!= ( ValueIterator< ValueType > const & other ) const

inline

Definition at line 242 of file ConfigTree.h.

        {
            return it_ != other.it_;
        }

References BaseLib::ConfigTree::ValueIterator< ValueType >::it_.

operator*()

template<typename ValueType >

ValueType BaseLib::ConfigTree::ValueIterator< ValueType >::operator* ( )

inline

Definition at line 224 of file ConfigTree.h.

        {
            // if this iterator has been incremented since the last dereference,
            // tell the parent_ instance that a setting now has been parsed.
            if (has_incremented_)
            {
                has_incremented_ = false;
                parent_.markVisited<ValueType>(tagname_, Attr::TAG, false);
            }
            return ConfigTree(it_->second, parent_, tagname_)
                .getValue<ValueType>();
        }

References BaseLib::ConfigTree::ConfigTree(), BaseLib::ConfigTree::ValueIterator< ValueType >::has_incremented_, BaseLib::ConfigTree::ValueIterator< ValueType >::it_, BaseLib::ConfigTree::markVisited(), BaseLib::ConfigTree::ValueIterator< ValueType >::parent_, BaseLib::ConfigTree::TAG, and BaseLib::ConfigTree::ValueIterator< ValueType >::tagname_.

operator++()

template<typename ValueType >

ValueIterator< ValueType > & BaseLib::ConfigTree::ValueIterator< ValueType >::operator++ ( )

inline

Definition at line 217 of file ConfigTree.h.

        {
            ++it_;
            has_incremented_ = true;
            return *this;
        }

References BaseLib::ConfigTree::ValueIterator< ValueType >::has_incremented_, and BaseLib::ConfigTree::ValueIterator< ValueType >::it_.

operator==()

template<typename ValueType >

bool BaseLib::ConfigTree::ValueIterator< ValueType >::operator== ( ValueIterator< ValueType > const & other ) const

inline

Definition at line 237 of file ConfigTree.h.

        {
            return it_ == other.it_;
        }

References BaseLib::ConfigTree::ValueIterator< ValueType >::it_.

Member Data Documentation

has_incremented_

template<typename ValueType >

bool BaseLib::ConfigTree::ValueIterator< ValueType >::has_incremented_ = true

private

Definition at line 248 of file ConfigTree.h.

Referenced by BaseLib::ConfigTree::ValueIterator< ValueType >::operator*(), and BaseLib::ConfigTree::ValueIterator< ValueType >::operator++().

it_

template<typename ValueType >

Iterator BaseLib::ConfigTree::ValueIterator< ValueType >::it_

private

Definition at line 249 of file ConfigTree.h.

Referenced by BaseLib::ConfigTree::ValueIterator< ValueType >::operator!=(), BaseLib::ConfigTree::ValueIterator< ValueType >::operator*(), BaseLib::ConfigTree::ValueIterator< ValueType >::operator++(), and BaseLib::ConfigTree::ValueIterator< ValueType >::operator==().

parent_

template<typename ValueType >

ConfigTree const& BaseLib::ConfigTree::ValueIterator< ValueType >::parent_

private

Definition at line 251 of file ConfigTree.h.

Referenced by BaseLib::ConfigTree::ValueIterator< ValueType >::operator*().

tagname_

template<typename ValueType >

std::string const BaseLib::ConfigTree::ValueIterator< ValueType >::tagname_

private

Definition at line 250 of file ConfigTree.h.

Referenced by BaseLib::ConfigTree::ValueIterator< ValueType >::operator*().

---

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

• BaseLib/ConfigTree.h