BaseLib::ConfigTree::SubtreeIterator Class Reference

Detailed Description

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

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

Definition at line 114 of file ConfigTree.h.

#include <ConfigTree.h>

Inheritance diagram for BaseLib::ConfigTree::SubtreeIterator:

Collaboration diagram for BaseLib::ConfigTree::SubtreeIterator:

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
	SubtreeIterator (Iterator const &it, std::string const &root, ConfigTree const &parent)
SubtreeIterator &	operator++ ()
ConfigTree	operator* ()
bool	operator== (SubtreeIterator const &other) const
bool	operator!= (SubtreeIterator const &other) const

Protected Attributes
std::string const	tagname_
ConfigTree const &	parent_

Private Attributes
bool	has_incremented_ = true
Iterator	it_

Member Typedef Documentation

difference_type

using BaseLib::ConfigTree::SubtreeIterator::difference_type = std::ptrdiff_t

Definition at line 119 of file ConfigTree.h.

Iterator

using BaseLib::ConfigTree::SubtreeIterator::Iterator = boost::property_tree::ptree::const_assoc_iterator

Definition at line 123 of file ConfigTree.h.

iterator_category

using BaseLib::ConfigTree::SubtreeIterator::iterator_category = std::input_iterator_tag

Definition at line 117 of file ConfigTree.h.

pointer

using BaseLib::ConfigTree::SubtreeIterator::pointer = ConfigTree*

Definition at line 120 of file ConfigTree.h.

reference

using BaseLib::ConfigTree::SubtreeIterator::reference = ConfigTree&

Definition at line 121 of file ConfigTree.h.

value_type

using BaseLib::ConfigTree::SubtreeIterator::value_type = ConfigTree

Definition at line 118 of file ConfigTree.h.

Constructor & Destructor Documentation

SubtreeIterator()

BaseLib::ConfigTree::SubtreeIterator::SubtreeIterator ( Iterator const & it, std::string const & root, ConfigTree const & parent )

inlineexplicit

Definition at line 125 of file ConfigTree.h.

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

Member Function Documentation

operator!=()

bool BaseLib::ConfigTree::SubtreeIterator::operator!= ( SubtreeIterator const & other ) const

inline

Definition at line 155 of file ConfigTree.h.

        {
            return it_ != other.it_;
        }

References it_.

operator*()

ConfigTree BaseLib::ConfigTree::SubtreeIterator::operator* ( )

inline

Definition at line 138 of file ConfigTree.h.

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

References BaseLib::ConfigTree::ConfigTree(), has_incremented_, it_, BaseLib::ConfigTree::markVisited(), parent_, BaseLib::ConfigTree::TAG, and tagname_.

Referenced by BaseLib::ConfigTree::ParameterIterator::operator*().

operator++()

SubtreeIterator & BaseLib::ConfigTree::SubtreeIterator::operator++ ( )

inline

Definition at line 131 of file ConfigTree.h.

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

References has_incremented_, and it_.

operator==()

bool BaseLib::ConfigTree::SubtreeIterator::operator== ( SubtreeIterator const & other ) const

inline

Definition at line 150 of file ConfigTree.h.

        {
            return it_ == other.it_;
        }

References it_.

Member Data Documentation

has_incremented_

bool BaseLib::ConfigTree::SubtreeIterator::has_incremented_ = true

private

Definition at line 161 of file ConfigTree.h.

Referenced by operator*(), and operator++().

it_

Iterator BaseLib::ConfigTree::SubtreeIterator::it_

private

Definition at line 162 of file ConfigTree.h.

Referenced by operator!=(), operator*(), operator++(), and operator==().

parent_

ConfigTree const& BaseLib::ConfigTree::SubtreeIterator::parent_

protected

Definition at line 166 of file ConfigTree.h.

Referenced by operator*(), and BaseLib::ConfigTree::ParameterIterator::operator*().

tagname_

std::string const BaseLib::ConfigTree::SubtreeIterator::tagname_

protected

Definition at line 165 of file ConfigTree.h.

Referenced by operator*(), and BaseLib::ConfigTree::ParameterIterator::operator*().

---

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

• BaseLib/ConfigTree.h