DSRXMLCursor Class Reference

Class for XML document cursors. More...

List of all members.

Public Member Functions

 DSRXMLCursor ()
 default constructor
 DSRXMLCursor (const DSRXMLCursor &cursor)
 copy constructor
virtual ~DSRXMLCursor ()
 destructor
DSRXMLCursor & operator= (const DSRXMLCursor &cursor)
 assignment operator
OFBool valid () const
 check whether cursor is valid.
DSRXMLCursor & gotoNext ()
 set cursor to next XML node (same level).
DSRXMLCursor & gotoChild ()
 set cursor to first XML child node (next lower level).
DSRXMLCursor getNext () const
 get cursor pointing to next XML node (same level).
DSRXMLCursor getChild () const
 get cursor pointing to first XML child node (next lower level).

Private Attributes

xmlNodePtr Node
 pointer to the associated 'libxml' node

Friends

class DSRXMLDocument

Detailed Description

Class for XML document cursors.

This class encapsulates the access to the 'libxml' node pointer and, therefore, allows to replace the XML library with little effort (if required).

Definition at line 77 of file dsrxmlc.h.

Constructor & Destructor Documentation

DSRXMLCursor::DSRXMLCursor (  const DSRXMLCursor &  cursor  ) 
 

copy constructor

Parameters:
cursor cursor object to be copied

Member Function Documentation

DSRXMLCursor DSRXMLCursor::getChild (   )  const
 

get cursor pointing to first XML child node (next lower level).

This cursor object is not modified.

Returns:
copy of the requested cursor object (might be invalid)

DSRXMLCursor DSRXMLCursor::getNext (   )  const
 

get cursor pointing to next XML node (same level).

This cursor object is not modified.

Returns:
copy of the requested cursor object (might be invalid)

DSRXMLCursor& DSRXMLCursor::gotoChild (   ) 
 

set cursor to first XML child node (next lower level).

Blank (empty or whitespace only) nodes are ignored/skipped.

Returns:
reference to this cursor object (might be invalid)

DSRXMLCursor& DSRXMLCursor::gotoNext (   ) 
 

set cursor to next XML node (same level).

Blank (empty or whitespace only) nodes are ignored/skipped.

Returns:
reference to this cursor object (might be invalid)

DSRXMLCursor& DSRXMLCursor::operator= (  const DSRXMLCursor &  cursor  ) 
 

assignment operator

Parameters:
cursor cursor object to be copied
Returns:
reference to this cursor object after 'cursor' has been copied

OFBool DSRXMLCursor::valid (  void   )  const [inline]
 

check whether cursor is valid.

Valid means that the cursor points to a valid XML node.

Returns:
OFTrue if valid, OFFalse otherwise

Definition at line 109 of file dsrxmlc.h.

References Node.

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

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5