configuration_item_string Class Reference

#include <string.h>

Inheritance diagram for configuration_item_string:

Public Member Functions
virtual	~configuration_item_string ()
configuration_item_string &	operator= (const configuration_item_string &rhs)
Static Public Member Functions
static pointer	create (const source_location &locn, level_t level, const rcstring &name, const rcstring &value)
static pointer	create (void)
static pointer	create (const configuration_item_string &rhs)
Protected Member Functions
rcstring	get_string_value (void) const
bool	get_bool_value (void) const
long	get_long_value (void) const
Private Member Functions
	configuration_item_string (const source_location &locn, level_t level, const rcstring &name, const rcstring &value)
	configuration_item_string ()
	configuration_item_string (const configuration_item_string &rhs)
Private Attributes
rcstring	value

---

Detailed Description

The configuration_item_string class is used to represent a configuration item that has a string value.

Definition at line 28 of file string.h.

---

Constructor & Destructor Documentation

configuration_item_string::~configuration_item_string

(

)

[virtual]

The destructor.

Definition at line 25 of file string.cc.

configuration_item_string::configuration_item_string	(	const source_location &	locn,
		level_t	level,
		const rcstring &	name,
		const rcstring &	value
	)		[private]

The constructor. It is private on purpose, use the create class method instead.

Parameters:

locn	The source file location of this configuration item.
level	The precedence level of this configuration item.
name	The name of this configuration item.
value	The string value of this configuration item.

Definition at line 30 of file string.cc.

configuration_item_string::configuration_item_string

(

)

[private]

The default constructor. Do not use.

configuration_item_string::configuration_item_string

(

const configuration_item_string &

rhs

)

[private]

The copy constructor. It is private on purpose, use a create method instead.

Parameters:

rhs	The right hand side of the initialization.

---

Member Function Documentation

configuration_item_string::pointer configuration_item_string::create	(	const source_location &	locn,
		level_t	level,
		const rcstring &	name,
		const rcstring &	value
	)		[static]

The create class method is used to create new dynamically allocated instances of this class.

Parameters:

locn	The source file location of this configuration item.
level	The precedence level of this configuration item.
name	The name of this configuration item.
value	The string value of this configuration item.

Definition at line 52 of file string.cc.

static pointer configuration_item_string::create

(

void

)

[static]

The create class method is used to create new dynamically allocated instances of this class.

static pointer configuration_item_string::create

(

const configuration_item_string &

rhs

)

[static]

The create class method is used to create new dynamically allocated instances of this class.

Parameters:

rhs	The right hand side of the initialization.

bool configuration_item_string::get_bool_value

(

void

)

const [protected, virtual]

The get_string_value method is used to obtain the value of this configuration item, as a boolean.

Implements configuration_item.

Definition at line 72 of file string.cc.

long configuration_item_string::get_long_value

(

void

)

const [protected, virtual]

The get_string_value method is used to obtain the value of this configuration item, as an integer.

Implements configuration_item.

Definition at line 87 of file string.cc.

rcstring configuration_item_string::get_string_value

(

void

)

const [protected, virtual]

The get_string_value method is used to obtain the value of this configuration item, as a string.

Implements configuration_item.

Definition at line 64 of file string.cc.

configuration_item_string& configuration_item_string::operator=

(

const configuration_item_string &

rhs

)

The assignment operator.

Parameters:

rhs	The right hand side of the assignment.

---

Field Documentation

rcstring configuration_item_string::value [private]

The value instance variable is used to remember the value of this configuration item. New settings will only "take" if they are of a higher precedence level.

Definition at line 85 of file string.h.

---

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

• lib/configuration/item/string.h
• lib/configuration/item/string.cc