class XrlAtomList

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

Definition#include <xrl_atom_list.hh>
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Types

Public Methods


Detailed Description

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.

 XrlAtomList ()

XrlAtomList

BadAtomType (class)

BadAtomType

InvalidIndex (class)

InvalidIndex

void  prepend (const XrlAtom& xa)
throw (BadAtomType)

prepend

Insert an XrlAtom at the front of the list.

Parameters:
xathe XrlAtom to be inserted.

void  append (const XrlAtom& xa)
throw (BadAtomType)

append

Insert an XrlAtom at the tail of the list.

Parameters:
xathe XrlAtom to be inserted.

const XrlAtom&  get (size_t itemno)
throw (InvalidIndex)

get

[const]

Retrieve an XrlAtom from list.

Parameters:
itemnothe index of the atom in the list.

Returns: the itemno - 1 XrlAtom in the list.

void  remove (size_t itemno)
throw (InvalidIndex)

remove

Removes an XrlAtom from list.

Parameters:
itemnothe index of the atom in the list to be removed.

size_t  size ()

size

[const]

Returns: number of XrlAtoms in the list.

bool  operator== (const XrlAtomList& x)

operator==

[const]

Test equality of with another XrlAtomList.

Returns: true if XrlAtomList's are the same.

string  str ()

str

[const]

Returns: a C++ string with the human-readable representation of the list.

 XrlAtomList (const string& s)

XrlAtomList

Construct from human-readable representation.


Generated by: pavlin on possum.icir.org on Mon Mar 10 19:34:49 2003, using kdoc 2.0a54+XORP.