rpt_value_pconf Class Reference

#include <pconf.h>

Inheritance diagram for rpt_value_pconf:

rpt_value

Public Member Functions

virtual ~rpt_value_pconf ()

Static Public Member Functions

static rpt_value::pointer create (const change::pointer &cp)

Protected Member Functions

const char * name () const
const char * type_of () const
bool is_a_struct () const
rpt_value::pointer lookup (const rpt_value::pointer &rhs, bool lval) const
rpt_value::pointer keys () const
rpt_value::pointer count () const
rpt_value::pointer undefer_or_null () const

Private Member Functions

 rpt_value_pconf (const change::pointer &cp)
void grab () const
 rpt_value_pconf ()
 rpt_value_pconf (const rpt_value_pconf &)
rpt_value_pconfoperator= (const rpt_value_pconf &)

Private Attributes

change::pointer cp
rpt_value::pointer value

Detailed Description

The rpt_value_pconf class is used to represent a deferred valie of a project's configuration data (aegis.conf file).

Definition at line 30 of file pconf.h.


Constructor & Destructor Documentation

virtual rpt_value_pconf::~rpt_value_pconf (  )  [virtual]

The destructor.

rpt_value_pconf::rpt_value_pconf ( const change::pointer cp  )  [private]

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

Parameters:
cp The change to use to access the project config data.

rpt_value_pconf::rpt_value_pconf (  )  [private]

The default constructor. Do not use.

rpt_value_pconf::rpt_value_pconf ( const rpt_value_pconf  )  [private]

The copy constructor. Do not use.


Member Function Documentation

static rpt_value::pointer rpt_value_pconf::create ( const change::pointer cp  )  [static]

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

Parameters:
cp The change to use to access the project config data.

const char* rpt_value_pconf::name (  )  const [protected, virtual]

The name method is used to obtain the name of the type of the value.

Implements rpt_value.

const char* rpt_value_pconf::type_of (  )  const [protected, virtual]

The type_of method is used to obtain the name of the type of the value. It differs from the name method in that it resolves references and deferred values.

Reimplemented from rpt_value.

bool rpt_value_pconf::is_a_struct (  )  const [protected, virtual]

The is_a_struct method may be used to determine whether or not the value is a struct (or associative array). Superficially, this should be simple, but it is complicated by things like deferred project and change states.

Returns:
true of struct-like values, false for everything else

Reimplemented from rpt_value.

rpt_value::pointer rpt_value_pconf::lookup ( const rpt_value::pointer rhs,
bool  lvalue 
) const [protected, virtual]

The lookup method is used to index an associate array, or locate a member within a struct.

Parameters:
rhs The member name, or array index
lvalue The result is to be used of an l-value

Reimplemented from rpt_value.

rpt_value::pointer rpt_value_pconf::keys (  )  const [protected, virtual]

The keys method is used to obtain a list of keys of an associative array.

Reimplemented from rpt_value.

rpt_value::pointer rpt_value_pconf::count (  )  const [protected, virtual]

The count method is used to count the number of elements of an associative array.

Reimplemented from rpt_value.

rpt_value::pointer rpt_value_pconf::undefer_or_null (  )  const [protected, virtual]

The undefer_or_null method is used to evaluate a deferred value, if necessary, or return NULL if it is not possible or not necessary. This NULL is used by the undefer class method to return the unchanged value if no conversion is possible.

Reimplemented from rpt_value.

void rpt_value_pconf::grab (  )  const [private]

The grab method is used to read in and convert the meta data.

rpt_value_pconf& rpt_value_pconf::operator= ( const rpt_value_pconf  )  [private]

The assignment operator. Do not use.


Field Documentation

The cp instance variable is used to remember the change through which to acess the project configuration data (particular;y as a change set is the mechanism to change it).

Definition at line 87 of file pconf.h.

The value instance variable is used to remember the read-in and converted meta-data.

It is mutable because performing the deferred read does not change the semantic value of the object.

Definition at line 96 of file pconf.h.


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

Generated on Wed Mar 12 23:37:44 2008 for Aegis by  doxygen 1.5.5