fawkes::SQLiteConfiguration::SQLiteValueIterator Class Reference

SQLite configuration value iterator. More...

#include <config/sqlite.h>

Inheritance diagram for fawkes::SQLiteConfiguration::SQLiteValueIterator:

[legend]
List of all members.

Public Member Functions

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

Protected Member Functions

 SQLiteValueIterator (::sqlite3_stmt *stmt, void *p=NULL)
 Constructor.

Friends

class SQLiteConfiguration

Detailed Description

SQLite configuration value iterator.

Definition at line 111 of file sqlite.h.


Constructor & Destructor Documentation

fawkes::SQLiteConfiguration::SQLiteValueIterator::SQLiteValueIterator ( ::sqlite3_stmt *  stmt,
void *  p = NULL 
) [protected]

Constructor.

Parameters:
stmt compiled SQLite statement
p pointer to arbitrary data that is freed (not deleted!) when the iterator is deleted.

Definition at line 2096 of file sqlite.cpp.

fawkes::SQLiteConfiguration::SQLiteValueIterator::~SQLiteValueIterator (  )  [virtual]

Destructor.

Definition at line 2104 of file sqlite.cpp.


Member Function Documentation

std::string fawkes::SQLiteConfiguration::SQLiteValueIterator::get_as_string (  )  [virtual]

Get value as string.

Returns:
value

Definition at line 2278 of file sqlite.cpp.

Referenced by FawkesMainThread::FawkesMainThread().

bool fawkes::SQLiteConfiguration::SQLiteValueIterator::get_bool (  )  [virtual]

Get bool value.

Returns:
value

Implements fawkes::Configuration::ValueIterator.

Definition at line 2259 of file sqlite.cpp.

std::string fawkes::SQLiteConfiguration::SQLiteValueIterator::get_comment (  )  [virtual]

Get comment.

Returns:
string comment value

Implements fawkes::Configuration::ValueIterator.

Definition at line 2287 of file sqlite.cpp.

float fawkes::SQLiteConfiguration::SQLiteValueIterator::get_float (  )  [virtual]

Get float value.

Returns:
value

Implements fawkes::Configuration::ValueIterator.

Definition at line 2225 of file sqlite.cpp.

int fawkes::SQLiteConfiguration::SQLiteValueIterator::get_int (  )  [virtual]

Get int value.

Returns:
value

Implements fawkes::Configuration::ValueIterator.

Definition at line 2250 of file sqlite.cpp.

std::string fawkes::SQLiteConfiguration::SQLiteValueIterator::get_modtype (  ) 

Get modification type.

This can only be called if the iterator has been retrieved via SQLiteConfiguration::modified_iterator(). Otherwise the return value is always and empty string.

Returns:
string modification type

Definition at line 2300 of file sqlite.cpp.

Referenced by FawkesMainThread::FawkesMainThread().

std::string fawkes::SQLiteConfiguration::SQLiteValueIterator::get_oldvalue (  ) 

Get old value (as string).

This can only be called if the iterator has been retrieved via SQLiteConfiguration::modified_iterator(). The value is always returned as string, as it is meant for debugging purposes only. Otherwise the return value is always and empty string.

Returns:
string modification type

Definition at line 2316 of file sqlite.cpp.

Referenced by FawkesMainThread::FawkesMainThread().

std::string fawkes::SQLiteConfiguration::SQLiteValueIterator::get_string (  )  [virtual]

Get string value.

Returns:
value

Implements fawkes::Configuration::ValueIterator.

Definition at line 2268 of file sqlite.cpp.

unsigned int fawkes::SQLiteConfiguration::SQLiteValueIterator::get_uint (  )  [virtual]

Get unsigned int value.

Returns:
value

Implements fawkes::Configuration::ValueIterator.

Definition at line 2235 of file sqlite.cpp.

bool fawkes::SQLiteConfiguration::SQLiteValueIterator::is_bool (  )  [virtual]

Check if current value is a bool.

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

Implements fawkes::Configuration::ValueIterator.

Definition at line 2199 of file sqlite.cpp.

bool fawkes::SQLiteConfiguration::SQLiteValueIterator::is_default (  )  [virtual]

Check if current value was read from the default config.

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

Implements fawkes::Configuration::ValueIterator.

Definition at line 2215 of file sqlite.cpp.

bool fawkes::SQLiteConfiguration::SQLiteValueIterator::is_float (  )  [virtual]

Check if current value is a float.

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

Implements fawkes::Configuration::ValueIterator.

Definition at line 2170 of file sqlite.cpp.

bool fawkes::SQLiteConfiguration::SQLiteValueIterator::is_int (  )  [virtual]

Check if current value is a int.

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

Implements fawkes::Configuration::ValueIterator.

Definition at line 2189 of file sqlite.cpp.

bool fawkes::SQLiteConfiguration::SQLiteValueIterator::is_string (  )  [virtual]

Check if current value is a string.

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

Implements fawkes::Configuration::ValueIterator.

Definition at line 2209 of file sqlite.cpp.

bool fawkes::SQLiteConfiguration::SQLiteValueIterator::is_uint (  )  [virtual]

Check if current value is a unsigned int.

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

Implements fawkes::Configuration::ValueIterator.

Definition at line 2180 of file sqlite.cpp.

bool fawkes::SQLiteConfiguration::SQLiteValueIterator::next (  )  [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

Implements fawkes::Configuration::ValueIterator.

Definition at line 2121 of file sqlite.cpp.

Referenced by FawkesMainThread::FawkesMainThread().

const char * fawkes::SQLiteConfiguration::SQLiteValueIterator::path (  )  [virtual]

Path of value.

Returns:
path of value

Implements fawkes::Configuration::ValueIterator.

Definition at line 2150 of file sqlite.cpp.

Referenced by FawkesMainThread::FawkesMainThread().

const char * fawkes::SQLiteConfiguration::SQLiteValueIterator::type (  )  [virtual]

Type of value.

Returns:
string representation of value type.

Implements fawkes::Configuration::ValueIterator.

Definition at line 2160 of file sqlite.cpp.

bool fawkes::SQLiteConfiguration::SQLiteValueIterator::valid (  )  [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

Implements fawkes::Configuration::ValueIterator.

Definition at line 2140 of file sqlite.cpp.


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