Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members  

Dv::Util::Env::Box Class Reference

Abstract base class for boxes. More...

#include <env.h>

Inherited by Dv::Util::Env::ABox, Dv::Util::Env::MBox, and Dv::Util::Env::SBox.

List of all members.

Public Methods

Type type () const
virtual iterator * begin () const throw (Exception)
virtual iterator * end () const throw (Exception)
 operator std::string & () throw (Exception)
 Convert SBox to string.

 operator const std::string & () const throw (Exception)
 Convert SBox to constant string reference.

virtual const std::string & svalue () const throw (Exception)
 Convert SBox to string.

virtual std::string & slvalue () throw (Exception)
 Convert SBox to constant string reference.

virtual Env * operator[] (int i) throw (Exception)
virtual const Env * operator() (int i) const throw (Exception)
virtual Env * operator[] (const std::string &s) throw (Exception)
virtual const Env * operator() (const std::string &s) const throw (Exception)
virtual ~Box ()

Detailed Description

Abstract base class for boxes.

Constructor & Destructor Documentation

virtual Dv::Util::Env::Box::~Box (    )  [virtual]
 

Member Function Documentation

Type Dv::Util::Env::Box::type (    )  const
 

Returns:
Type of box.
Warning:
Uses dynamic_cast on *this.

virtual iterator* Dv::Util::Env::Box::begin (    )  const throw (Exception) [virtual]
 

Returns:
iterator pointing to first element (or end()) of container box.
Exceptions:
Exception  if not a map or array box.

Reimplemented in Dv::Util::Env::MBox, and Dv::Util::Env::ABox.

virtual iterator* Dv::Util::Env::Box::end (    )  const throw (Exception) [virtual]
 

Returns:
iterator pointing past the last element of a container box.
Exceptions:
Exception  if not a map or array box.

Reimplemented in Dv::Util::Env::MBox, and Dv::Util::Env::ABox.

Dv::Util::Env::Box::operator std::string & (    )  throw (Exception) [inline]
 

Convert SBox to string.

Returns:
lvalue string of SBox.
Exceptions:
Exception  if not a string box.
See also:
Box::slvalue()

Dv::Util::Env::Box::operator const std::string & (    )  const throw (Exception) [inline]
 

Convert SBox to constant string reference.

Returns:
constant string reference of SBox.
Exceptions:
Exception  if not a string box.
See also:
Box::svalue()

virtual const std::string& Dv::Util::Env::Box::svalue (    )  const throw (Exception) [virtual]
 

Convert SBox to string.

Returns:
lvalue string of SBox.
Exceptions:
Exception  if not a string box.

Reimplemented in Dv::Util::Env::SBox.

virtual std::string& Dv::Util::Env::Box::slvalue (    )  throw (Exception) [virtual]
 

Convert SBox to constant string reference.

Returns:
constant string reference of SBox.
Exceptions:
Exception  if not a string box.

Reimplemented in Dv::Util::Env::SBox.

virtual Env* Dv::Util::Env::Box::operator[] (  int    i )  throw (Exception) [virtual]
 

Returns:
non-const pointer to environment corresponding to index i in ABox.
Parameters:
i  index to use
Exceptions:
Exception  if not an ABox.

Reimplemented in Dv::Util::Env::ABox.

virtual const Env* Dv::Util::Env::Box::operator() (  int    i )  const throw (Exception) [virtual]
 

Returns:
const pointer to environment corresponding to index i in ABox.
Parameters:
i  index to use
Exceptions:
Exception  if not an ABox.

Reimplemented in Dv::Util::Env::ABox.

virtual Env* Dv::Util::Env::Box::operator[] (  const std::string &    s )  throw (Exception) [virtual]
 

Returns:
non-const pointer to environment corresponding to key s in MBox.
Parameters:
s  key to use
Exceptions:
Exception  if not an MBox.

Reimplemented in Dv::Util::Env::MBox.

virtual const Env* Dv::Util::Env::Box::operator() (  const std::string &    s )  const throw (Exception) [virtual]
 

Returns:
const pointer to environment corresponding to key s in MBox.
Parameters:
s  key to use
Exceptions:
Exception  if not an MBox.

Reimplemented in Dv::Util::Env::MBox.

The documentation for this class was generated from the following file:
dvenv-0.2.2 [20 October, 2002]