ALib C++ Library
Library Version: 2312 R0
Documentation generated by doxygen
Public Fields | Public Methods | List of all members
Configuration::Iterator Class Referenceabstract

#include <configuration.hpp>

Collaboration diagram for Configuration::Iterator:
[legend]

Class Description


Iterator interface class, returned by method GetIterator.

Definition at line 428 of file configuration.hpp.

Public Fields

Variable Actual
 

Public Methods

virtual ~Iterator ()
 
virtual bool Next ()=0
 
virtual void ResetToSection (const String &sectionName)=0
 

Constructor & Destructor Documentation

◆ ~Iterator()

virtual ~Iterator ( )
inlinevirtual

Virtual destructor.

Definition at line 435 of file configuration.hpp.

Member Function Documentation

◆ Next()

virtual bool Next ( )
pure virtual

Searches and loads the next variable from the iterated section. On success, the variable data is stored in Actual.

Returns
true, if a next variable was found. false otherwise.

◆ ResetToSection()

virtual void ResetToSection ( const String sectionName)
pure virtual

Resets this iterator to work on a different section of the same configuration.

Parameters
sectionNameThe name of the section to iterate.

Member Data Documentation

◆ Actual

Variable Actual

The actual variable loaded with successful call to Next.

Definition at line 432 of file configuration.hpp.


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