senf::console::detail::BundleMixin Class Reference

Internal: Provide ConfigBundle facade for a single-source config. More...

#include <senf/Utils/Console/Config.hh>

Inheritance diagram for senf::console::detail::BundleMixin:

Public Member Functions

 BundleMixin ()
 
 BundleMixin (DirectoryNode &root)
 
void parse ()
 Parse config file. More...
 
void parse (DirectoryNode &restrict)
 Parse config file under restrict. More...
 
bool complete () const
 true, if all nodes have been parsed More...
 
bool parsed (GenericNode &node) const
 true. if node has been parsed More...
 
void reset ()
 Reset node parse info state. More...
 

Protected Member Functions

template<class Source >
Source & add (boost::intrusive_ptr< Source > source)
 

Detailed Description

Internal: Provide ConfigBundle facade for a single-source config.

The BundleMixin is used to define supplementary configuration objects for one specific configuration source. A BundleMixin is not a ConfigBundle since it has no public add() member.

Definition at line 105 of file Config.hh.

Constructor & Destructor Documentation

◆ BundleMixin() [1/2]

senf::console::detail::BundleMixin::BundleMixin ( )

◆ BundleMixin() [2/2]

senf::console::detail::BundleMixin::BundleMixin ( DirectoryNode root)

Member Function Documentation

◆ add()

template<class Source >
Source& senf::console::detail::BundleMixin::add ( boost::intrusive_ptr< Source >  source)
protected

◆ complete()

bool senf::console::detail::BundleMixin::complete ( ) const

true, if all nodes have been parsed

◆ parse() [1/2]

void senf::console::detail::BundleMixin::parse ( )

Parse config file.

All nodes already parsed are skipped

◆ parse() [2/2]

void senf::console::detail::BundleMixin::parse ( DirectoryNode restrict)

Parse config file under restrict.

Only nodes which are children of restrict are parsed.

◆ parsed()

bool senf::console::detail::BundleMixin::parsed ( GenericNode node) const

true. if node has been parsed

◆ reset()

void senf::console::detail::BundleMixin::reset ( )

Reset node parse info state.

After a call to reset(), all information about already parsed nodes is cleared. Calling parse() will parse the complete config file again.


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