configuration::bounded_int_configlet Class Reference

Stores an integer in a configuration repository with range checking. More...

#include <configlet.h>

Inheritance diagram for configuration::bounded_int_configlet:
Inheritance graph
[legend]
Collaboration diagram for configuration::bounded_int_configlet:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 bounded_int_configlet (const basis::astring &section, const basis::astring &entry, int current_value, int default_value, int minimum, int maximum)
virtual ~bounded_int_configlet ()
virtual void current_value (int new_current)
 the modifier function is virtual so derived classes can extend.
int minimum () const
int maximum () const
void minimum (int new_min)
void maximum (int new_max)
configletduplicate () const
 a virtual copy constructor for configlets.

Detailed Description

Stores an integer in a configuration repository with range checking.

a bounded_int_configlet has current and default values but also specifies a valid range for the current value. if the current value falls outside of that range (even via a "set" operation), then the default value is used for the current.

Definition at line 150 of file configlet.h.


Constructor & Destructor Documentation

configuration::bounded_int_configlet::bounded_int_configlet ( const basis::astring section,
const basis::astring entry,
int  current_value,
int  default_value,
int  minimum,
int  maximum 
)

Definition at line 153 of file configlet.cpp.

Referenced by duplicate().

configuration::bounded_int_configlet::~bounded_int_configlet (  )  [virtual]

Definition at line 162 of file configlet.cpp.


Member Function Documentation

void configuration::bounded_int_configlet::current_value ( int  new_current  )  [virtual]

the modifier function is virtual so derived classes can extend.

Reimplemented from configuration::int_configlet.

Definition at line 164 of file configlet.cpp.

References configuration::int_configlet::current_value(), and configuration::int_configlet::default_value().

configlet * configuration::bounded_int_configlet::duplicate (  )  const [virtual]

a virtual copy constructor for configlets.

the returned object will be a new copy of this configlet.

Reimplemented from configuration::int_configlet.

Definition at line 173 of file configlet.cpp.

References bounded_int_configlet().

void configuration::bounded_int_configlet::maximum ( int  new_max  )  [inline]

Definition at line 163 of file configlet.h.

int configuration::bounded_int_configlet::maximum (  )  const [inline]

Definition at line 160 of file configlet.h.

void configuration::bounded_int_configlet::minimum ( int  new_min  )  [inline]

Definition at line 162 of file configlet.h.

int configuration::bounded_int_configlet::minimum (  )  const [inline]

Definition at line 159 of file configlet.h.


The documentation for this class was generated from the following files:
Generated on Sat Jan 28 04:25:27 2012 for hoople2 project by  doxygen 1.6.3