DCMTK  Version 3.6.1 20120515
OFFIS DICOM Toolkit
Public Member Functions | Private Member Functions | Private Attributes
LST_HEAD Class Reference

general purpose list class for use with dcmnet module. More...

List of all members.

Public Member Functions

 LST_HEAD ()
 default constructor
 ~LST_HEAD ()
 destructor, deletes list but not elements pointed to by list entries.
void push_back (void *node)
 inserts after the last element of the list.
void * dequeue ()
 removes first element from list and returns it.
size_t size () const
 returns number of elements in the list.
void * front ()
 returns the first element in the list.
void * position (void *node)
 Make a node current and return the argument.
void * next ()
 Advances the current element to the next element in the list and returns a pointer to the next element (if any), NULL otherwise.
void * current () const
 Returns pointer to current element in list.

Private Member Functions

 OFListIterator (void *) theIterator
 list iterator, points to current element

Private Attributes

OFList< void * > theList
 the list

Detailed Description

general purpose list class for use with dcmnet module.


Member Function Documentation

void* LST_HEAD::current ( ) const

Returns pointer to current element in list.

A valid current element must exist (e.g. position() called with an existing element), otherwise the behaviour is undefined.

void* LST_HEAD::dequeue ( )

removes first element from list and returns it.

Returns NULL if list is empty.

void* LST_HEAD::front ( )

returns the first element in the list.

Returns:
first element in list, NULL if list empty
void* LST_HEAD::next ( )

Advances the current element to the next element in the list and returns a pointer to the next element (if any), NULL otherwise.

A valid current element must exist (e.g. position() called with an existing element), otherwise the behaviour is undefined.

void* LST_HEAD::position ( void *  node)

Make a node current and return the argument.

Parameters:
nodepointer to element which must be contained in the list
Returns:
pointer to node if successful, NULL otherwise
void LST_HEAD::push_back ( void *  node)

inserts after the last element of the list.

Parameters:
nodevalue inserted into the list
size_t LST_HEAD::size ( ) const

returns number of elements in the list.

Returns:
number of elements

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


Generated on Tue May 15 2012 for DCMTK Version 3.6.1 20120515 by Doxygen 1.7.5.1-20111027