xorp

XrlAtomList Class Reference

List class to contain XrlAtom's of one type. More...

#include <xrl_atom_list.hh>

List of all members.

Classes

struct  BadAtomType
struct  InvalidIndex

Public Member Functions

void prepend (const XrlAtom &xa) throw (BadAtomType)
 Insert an XrlAtom at the front of the list.
void append (const XrlAtom &xa) throw (BadAtomType)
 Insert an XrlAtom at the tail of the list.
const XrlAtomget (size_t itemno) const throw (InvalidIndex)
 Retrieve an XrlAtom from list.
void remove (size_t itemno) throw (InvalidIndex)
 Removes an XrlAtom from list.
size_t size () const
bool operator== (const XrlAtomList &x) const
 Test equality of with another XrlAtomList.
string str () const
 XrlAtomList (const string &s)
 Construct from human-readable representation.
size_t modify (size_t item, const uint8_t *buf, size_t len)
void set_size (size_t size)

Private Member Functions

void check_type (const XrlAtom &xa) throw (BadAtomType)
void do_append (const XrlAtom &xa)

Private Attributes

list< XrlAtom_list
size_t _size

Detailed Description

List class to contain XrlAtom's of one type.

The XrlAtomList class is used to pass lists of XrlAtoms of a given type in Xrl calls. The XrlAtom type that the list supports is determined by the first XrlAtom added to the list via the prepend() and append() methods.


Member Function Documentation

void XrlAtomList::append ( const XrlAtom xa) throw (BadAtomType)

Insert an XrlAtom at the tail of the list.

Parameters:
xathe XrlAtom to be inserted.
const XrlAtom & XrlAtomList::get ( size_t  itemno) const throw (InvalidIndex)

Retrieve an XrlAtom from list.

Parameters:
itemnothe index of the atom in the list.
Returns:
the itemno - 1 XrlAtom in the list.
bool XrlAtomList::operator== ( const XrlAtomList x) const

Test equality of with another XrlAtomList.

Returns:
true if XrlAtomList's are the same.
void XrlAtomList::prepend ( const XrlAtom xa) throw (BadAtomType)

Insert an XrlAtom at the front of the list.

Parameters:
xathe XrlAtom to be inserted.
void XrlAtomList::remove ( size_t  itemno) throw (InvalidIndex)

Removes an XrlAtom from list.

Parameters:
itemnothe index of the atom in the list to be removed.
size_t XrlAtomList::size ( ) const
Returns:
number of XrlAtoms in the list.
string XrlAtomList::str ( ) const
Returns:
a C++ string with the human-readable representation of the list.

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations