fawkes::NetworkConfiguration::NetConfValueIterator Class Reference

Network configuration value iterator. More...

#include <config/netconf.h>

Inheritance diagram for fawkes::NetworkConfiguration::NetConfValueIterator:

[legend]
List of all members.

Public Member Functions

virtual ~NetConfValueIterator ()
 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_comment ()
 Get comment of value.

Protected Member Functions

 NetConfValueIterator (Configuration::ValueIterator *i)
 Constructor.
 NetConfValueIterator (FawkesNetworkMessage *m)
 Constructor.
 NetConfValueIterator ()
 Constructor.

Friends

class NetworkConfiguration

Detailed Description

Network configuration value iterator.

Author:
Tim Niemueller

Definition at line 114 of file netconf.h.


Constructor & Destructor Documentation

fawkes::NetworkConfiguration::NetConfValueIterator::NetConfValueIterator ( Configuration::ValueIterator i  )  [protected]

Constructor.

Parameters:
i internal other iterator, for instance form local mirrored database.

Definition at line 1395 of file netconf.cpp.

fawkes::NetworkConfiguration::NetConfValueIterator::NetConfValueIterator ( FawkesNetworkMessage m  )  [protected]

Constructor.

Internally holds a message. Only this one value is accessible.

Parameters:
m message

Definition at line 1422 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::cid(), fawkes::FawkesNetworkMessage::msgid(), fawkes::config_descriptor_t::path, fawkes::FawkesNetworkMessage::payload(), fawkes::FawkesNetworkMessage::payload_size(), and fawkes::RefCount::ref().

fawkes::NetworkConfiguration::NetConfValueIterator::NetConfValueIterator (  )  [protected]

Constructor.

Returns invalid iterator.

Definition at line 1408 of file netconf.cpp.

fawkes::NetworkConfiguration::NetConfValueIterator::~NetConfValueIterator (  )  [virtual]

Destructor.

Definition at line 1448 of file netconf.cpp.

References fawkes::RefCount::unref().


Member Function Documentation

bool fawkes::NetworkConfiguration::NetConfValueIterator::get_bool (  )  [virtual]

Get bool value.

Returns:
value

Implements fawkes::Configuration::ValueIterator.

Definition at line 1690 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msg(), and fawkes::FawkesNetworkMessage::msgid().

std::string fawkes::NetworkConfiguration::NetConfValueIterator::get_comment (  )  [virtual]

Get comment of value.

Returns:
comment

Implements fawkes::Configuration::ValueIterator.

Definition at line 1729 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msgge(), and fawkes::FawkesNetworkMessage::msgid().

float fawkes::NetworkConfiguration::NetConfValueIterator::get_float (  )  [virtual]

Get float value.

Returns:
value

Implements fawkes::Configuration::ValueIterator.

Definition at line 1633 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msg(), and fawkes::FawkesNetworkMessage::msgid().

int fawkes::NetworkConfiguration::NetConfValueIterator::get_int (  )  [virtual]

Get int value.

Returns:
value

Implements fawkes::Configuration::ValueIterator.

Definition at line 1671 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msg(), and fawkes::FawkesNetworkMessage::msgid().

std::string fawkes::NetworkConfiguration::NetConfValueIterator::get_string (  )  [virtual]

Get string value.

Returns:
value

Implements fawkes::Configuration::ValueIterator.

Definition at line 1709 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msgge(), and fawkes::FawkesNetworkMessage::msgid().

unsigned int fawkes::NetworkConfiguration::NetConfValueIterator::get_uint (  )  [virtual]

Get unsigned int value.

Returns:
value

Implements fawkes::Configuration::ValueIterator.

Definition at line 1652 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msg(), and fawkes::FawkesNetworkMessage::msgid().

bool fawkes::NetworkConfiguration::NetConfValueIterator::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 1560 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msgid().

bool fawkes::NetworkConfiguration::NetConfValueIterator::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 1588 of file netconf.cpp.

References fawkes::config_string_value_msg_t::cp, fawkes::config_bool_value_msg_t::cp, fawkes::config_int_value_msg_t::cp, fawkes::config_uint_value_msg_t::cp, fawkes::config_float_value_msg_t::cp, fawkes::config_descriptor_t::is_default, fawkes::FawkesNetworkMessage::msg(), fawkes::FawkesNetworkMessage::msgge(), and fawkes::FawkesNetworkMessage::msgid().

bool fawkes::NetworkConfiguration::NetConfValueIterator::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 1518 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msgid().

bool fawkes::NetworkConfiguration::NetConfValueIterator::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 1546 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msgid().

bool fawkes::NetworkConfiguration::NetConfValueIterator::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 1574 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msgid().

bool fawkes::NetworkConfiguration::NetConfValueIterator::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 1532 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msgid().

bool fawkes::NetworkConfiguration::NetConfValueIterator::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 1457 of file netconf.cpp.

const char * fawkes::NetworkConfiguration::NetConfValueIterator::path (  )  [virtual]

Path of value.

Returns:
path of value

Implements fawkes::Configuration::ValueIterator.

Definition at line 1480 of file netconf.cpp.

const char * fawkes::NetworkConfiguration::NetConfValueIterator::type (  )  [virtual]

Type of value.

Returns:
string representation of value type.

Implements fawkes::Configuration::ValueIterator.

Definition at line 1495 of file netconf.cpp.

References fawkes::FawkesNetworkMessage::msgid().

bool fawkes::NetworkConfiguration::NetConfValueIterator::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 1473 of file netconf.cpp.


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