fawkes::Configuration::ValueIterator Class Reference

Iterator interface to iterate over config values. More...

#include <config/config.h>

Inheritance diagram for fawkes::Configuration::ValueIterator:

[legend]
List of all members.

Public Member Functions

virtual ~ValueIterator ()
 Virtual emptry destructor.
virtual bool next ()=0
 Check if there is another element and advance to this if possible.
virtual bool valid ()=0
 Check if the current element is valid.
virtual const char * path ()=0
 Path of value.
virtual const char * type ()=0
 Type of value.
virtual bool is_float ()=0
 Check if current value is a float.
virtual bool is_uint ()=0
 Check if current value is a unsigned int.
virtual bool is_int ()=0
 Check if current value is a int.
virtual bool is_bool ()=0
 Check if current value is a bool.
virtual bool is_string ()=0
 Check if current value is a string.
virtual float get_float ()=0
 Get float value.
virtual unsigned int get_uint ()=0
 Get unsigned int value.
virtual int get_int ()=0
 Get int value.
virtual bool get_bool ()=0
 Get bool value.
virtual std::string get_string ()=0
 Get string value.
virtual std::string get_comment ()=0
 Get comment of value.
virtual bool is_default ()=0
 Check if current value was read from the default config.

Detailed Description

Iterator interface to iterate over config values.

This does not implement a classic iterator interface with begin and end nodes but rather mimics a more Java-like interface where you iterate over the entries in a while loop until you covered all entries (much like a queue). If you implement this for your own configuration system you should not make the constructor publically accessible.

Definition at line 67 of file config.h.


Constructor & Destructor Documentation

fawkes::Configuration::ValueIterator::~ValueIterator (  )  [inline, virtual]

Virtual emptry destructor.

Definition at line 70 of file config.h.


Member Function Documentation

bool fawkes::Configuration::ValueIterator::get_bool (  )  [pure virtual]

Get bool value.

Returns:
value

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), fawkes::SQLiteConfiguration::copy(), and fawkes::NetworkConfiguration::copy().

std::string fawkes::Configuration::ValueIterator::get_comment (  )  [pure virtual]

Get comment of value.

Returns:
comment

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append().

float fawkes::Configuration::ValueIterator::get_float (  )  [pure virtual]

Get float value.

Returns:
value

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), fawkes::SQLiteConfiguration::copy(), and fawkes::NetworkConfiguration::copy().

int fawkes::Configuration::ValueIterator::get_int (  )  [pure virtual]

Get int value.

Returns:
value

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), fawkes::SQLiteConfiguration::copy(), and fawkes::NetworkConfiguration::copy().

std::string fawkes::Configuration::ValueIterator::get_string (  )  [pure virtual]

Get string value.

Returns:
value

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), BlackBoardLoggerPlugin::BlackBoardLoggerPlugin(), fawkes::SQLiteConfiguration::copy(), fawkes::NetworkConfiguration::copy(), FvRetrieverPlugin::FvRetrieverPlugin(), EclipseAgentThread::init(), and RetrieverConfigPlugin::pre_run().

unsigned int fawkes::Configuration::ValueIterator::get_uint (  )  [pure virtual]

Get unsigned int value.

Returns:
value

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), fawkes::SQLiteConfiguration::copy(), and fawkes::NetworkConfiguration::copy().

bool fawkes::Configuration::ValueIterator::is_bool (  )  [pure virtual]

Check if current value is a bool.

Returns:
true, if value is a bool, false otherwise

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), fawkes::SQLiteConfiguration::copy(), and fawkes::NetworkConfiguration::copy().

bool fawkes::Configuration::ValueIterator::is_default (  )  [pure virtual]

Check if current value was read from the default config.

Returns:
true, if value was read from the default config, false otherwise

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append().

bool fawkes::Configuration::ValueIterator::is_float (  )  [pure virtual]

Check if current value is a float.

Returns:
true, if value is a float, false otherwise

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), fawkes::SQLiteConfiguration::copy(), and fawkes::NetworkConfiguration::copy().

bool fawkes::Configuration::ValueIterator::is_int (  )  [pure virtual]

Check if current value is a int.

Returns:
true, if value is a int, false otherwise

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), fawkes::SQLiteConfiguration::copy(), and fawkes::NetworkConfiguration::copy().

bool fawkes::Configuration::ValueIterator::is_string (  )  [pure virtual]

Check if current value is a string.

Returns:
true, if value is a string, false otherwise

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), fawkes::SQLiteConfiguration::copy(), fawkes::NetworkConfiguration::copy(), FvRetrieverPlugin::FvRetrieverPlugin(), EclipseAgentThread::init(), and RetrieverConfigPlugin::pre_run().

bool fawkes::Configuration::ValueIterator::is_uint (  )  [pure virtual]

Check if current value is a unsigned int.

Returns:
true, if value is a unsigned int, false otherwise

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), fawkes::SQLiteConfiguration::copy(), and fawkes::NetworkConfiguration::copy().

bool fawkes::Configuration::ValueIterator::next (  )  [pure virtual]

Check if there is another element and advance to this if possible.

This advances to the next element, if there is one.

Returns:
true, if another element has been reached, false otherwise

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by BlackBoardLoggerPlugin::BlackBoardLoggerPlugin(), BlackBoardSynchronizationPlugin::BlackBoardSynchronizationPlugin(), fawkes::SQLiteConfiguration::copy(), fawkes::NetworkConfiguration::copy(), FvRetrieverPlugin::FvRetrieverPlugin(), WorldModelThread::init(), EclipseAgentThread::init(), LaserDeadSpotsDataFilter::LaserDeadSpotsDataFilter(), fawkes::ConfigNetworkHandler::loop(), PanTiltPlugin::PanTiltPlugin(), and RetrieverConfigPlugin::pre_run().

const char * fawkes::Configuration::ValueIterator::path (  )  [pure virtual]

Path of value.

Returns:
path of value

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by fawkes::ConfigListContent::append(), BlackBoardLoggerPlugin::BlackBoardLoggerPlugin(), BlackBoardSynchronizationPlugin::BlackBoardSynchronizationPlugin(), fawkes::SQLiteConfiguration::copy(), fawkes::NetworkConfiguration::copy(), FvRetrieverPlugin::FvRetrieverPlugin(), WorldModelThread::init(), LaserDeadSpotsDataFilter::LaserDeadSpotsDataFilter(), PanTiltPlugin::PanTiltPlugin(), and RetrieverConfigPlugin::pre_run().

const char * fawkes::Configuration::ValueIterator::type (  )  [pure virtual]

Type of value.

Returns:
string representation of value type.

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.

Referenced by FvRetrieverPlugin::FvRetrieverPlugin(), fawkes::NetworkConfiguration::get_type(), WorldModelThread::init(), and RetrieverConfigPlugin::pre_run().

bool fawkes::Configuration::ValueIterator::valid (  )  [pure virtual]

Check if the current element is valid.

This is much like the classic end element for iterators. If the iterator is invalid there all subsequent calls to next() shall fail.

Returns:
true, if the iterator is still valid, false otherwise

Implemented in fawkes::NetworkConfiguration::NetConfValueIterator, and fawkes::SQLiteConfiguration::SQLiteValueIterator.


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:31:38 2011 for Fawkes API by  doxygen 1.4.7