Detailed Description

Manages a ConfigTree and the boost::property_tree it depends on.

The whole purpose of this class is making the management of said dependency easy.

Definition at line 22 of file ConfigTreeUtil.h.

#include <ConfigTreeUtil.h>

Collaboration diagram for BaseLib::ConfigTreeTopLevel:

Public Member Functions
	ConfigTreeTopLevel (std::string const &filepath, bool const be_ruthless, ConfigTree::PTree &&ptree)

ConfigTree const &	operator* () const

ConfigTree const *	operator-> () const

void	checkAndInvalidate ()

Private Attributes
ConfigTree::PTree const	ptree_
	`boost::property_tree` that underlies `ctree_` More...

ConfigTree	ctree_
	ConfigTree depending on `ptree_`. More...

Constructor & Destructor Documentation

◆ ConfigTreeTopLevel()

BaseLib::ConfigTreeTopLevel::ConfigTreeTopLevel	(	std::string const &	filepath,
		bool const	be_ruthless,
		ConfigTree::PTree &&	ptree
	)

explicit

Construct a new instance from the given data.

Parameters

filepath	stored for use in error/warning messages
be_ruthless	if true, then warnings will raise errors, .i.e. lead to program abortion, else warnings will only warn
ptree	the underlying ptree of the created ConfigTree

Definition at line 28 of file ConfigTreeUtil.cpp.

     : ptree_(std::move(ptree)),
       ctree_(ptree_, filepath, ConfigTree::onerror,
              be_ruthless ? ConfigTree::onerror : ConfigTree::onwarning)
 {
 }

Member Function Documentation

◆ checkAndInvalidate()

void BaseLib::ConfigTreeTopLevel::checkAndInvalidate ( )

Check if the contained ConfigTree has been processed entirely.

This only checks the top level, as usual with ConfigTree instances.

Postcondition: Afterwards the contained ConfigTree instance must not be used anymore!

Definition at line 47 of file ConfigTreeUtil.cpp.

 {
     ::BaseLib::checkAndInvalidate(ctree_);
 }

References BaseLib::checkAndInvalidate(), and ctree_.

◆ operator*()

ConfigTree const & BaseLib::ConfigTreeTopLevel::operator* ( ) const

Access the contained ConfigTree.

The non-const version of this method has not been implemented in order to prevent invalidating the ctree_ when it is passed around. In order to check and invalidate ctree_ use the provided member function.

Definition at line 37 of file ConfigTreeUtil.cpp.

 {
     return ctree_;
 }

References ctree_.

◆ operator->()

ConfigTree const * BaseLib::ConfigTreeTopLevel::operator-> ( ) const

Access the contained ConfigTree.

The non-const version of this method has not been implemented in order to prevent invalidating the ctree_ when it is passed around. In order to check and invalidate ctree_ use the provided member function.

Definition at line 42 of file ConfigTreeUtil.cpp.

 {
     return &ctree_;
 }

References ctree_.

Member Data Documentation

◆ ctree_

ConfigTree BaseLib::ConfigTreeTopLevel::ctree_

private

ConfigTree depending on ptree_.

Definition at line 64 of file ConfigTreeUtil.h.

Referenced by checkAndInvalidate(), operator*(), and operator->().

◆ ptree_

ConfigTree::PTree const BaseLib::ConfigTreeTopLevel::ptree_

private

boost::property_tree that underlies ctree_

Definition at line 63 of file ConfigTreeUtil.h.

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

BaseLib/ConfigTreeUtil.h
BaseLib/ConfigTreeUtil.cpp