dcmsr/include/dsrtncsr.h

/*
 *
 *  Copyright (C) 2000-2003, OFFIS
 *
 *  This software and supporting documentation were developed by
 *
 *    Kuratorium OFFIS e.V.
 *    Healthcare Information and Communication Systems
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *  THIS SOFTWARE IS MADE AVAILABLE,  AS IS,  AND OFFIS MAKES NO  WARRANTY
 *  REGARDING  THE  SOFTWARE,  ITS  PERFORMANCE,  ITS  MERCHANTABILITY  OR
 *  FITNESS FOR ANY PARTICULAR USE, FREEDOM FROM ANY COMPUTER DISEASES  OR
 *  ITS CONFORMITY TO ANY SPECIFICATION. THE ENTIRE RISK AS TO QUALITY AND
 *  PERFORMANCE OF THE SOFTWARE IS WITH THE USER.
 *
 *  Module: dcmsr
 *
 *  Author: Joerg Riesmeier
 *
 *  Purpose:
 *    classes: DSRTreeNodeCursor
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2003/08/07 12:55:46 $
 *  CVS/RCS Revision: $Revision: 1.10 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DSRTNCSR_H
#define DSRTNCSR_H

#include "osconfig.h"   /* make sure OS specific configuration is included first */

#include "ofstring.h"
#include "ofstack.h"
#include "oflist.h"


/*-----------------------*
 *  forward declaration  *
 *-----------------------*/

class DSRTreeNode;


/*-------------------*
 *  type definition  *
 *-------------------*/

// this typedef is needed to avoid a warning on Sun CC 2.0.1
typedef DSRTreeNode *DSRTreeNodePointer;


/*---------------------*
 *  class declaration  *
 *---------------------*/

class DSRTreeNodeCursor
{

  public:

    DSRTreeNodeCursor();

    DSRTreeNodeCursor(const DSRTreeNodeCursor &cursor);

    DSRTreeNodeCursor(DSRTreeNode *node);

    virtual ~DSRTreeNodeCursor();

    DSRTreeNodeCursor &operator=(const DSRTreeNodeCursor &cursor);

    DSRTreeNodeCursor &operator=(DSRTreeNode *node);

    virtual void clear();

    virtual OFBool isValid() const;

    inline DSRTreeNode *getNode() const
    {
        return NodeCursor;
    }

    const DSRTreeNode *getParentNode();

    const DSRTreeNode *getNextNode() const;

    size_t gotoPrevious();

    size_t gotoNext();

    size_t goUp();

    size_t goDown();

    size_t iterate();

    size_t gotoNode(const size_t searchID);

    size_t gotoNode(const OFString &position,
                    const char separator = '.');

    size_t getNodeID() const;

    size_t getLevel() const;

    const OFString &getPosition(OFString &position,
                                const char separator = '.') const;


  protected:

    void clearNodeCursorStack();

    size_t setCursor(DSRTreeNode *node);

    DSRTreeNode *NodeCursor;
    OFStack< DSRTreeNodePointer > NodeCursorStack;

    size_t Position;
    OFList<size_t> PositionList;
};


#endif


/*
 *  CVS/RCS Log:
 *  $Log: dsrtncsr.h,v $
 *  Revision 1.10  2003/08/07 12:55:46  joergr
 *  Updated documentation to get rid of doxygen warnings.
 *
 *  Revision 1.9  2001/12/18 09:55:06  meichel
 *  Introduced typedef to avoid warning on Sun CC 2.0.1
 *
 *  Revision 1.8  2001/03/28 09:06:56  joergr
 *  Fixed bug in cycle/loop detection "algorithm".
 *
 *  Revision 1.7  2000/11/09 20:32:08  joergr
 *  Added support for non-ASCII characters in HTML 3.2 (use numeric value).
 *
 *  Revision 1.6  2000/11/07 18:14:31  joergr
 *  Enhanced support for by-reference relationships.
 *
 *  Revision 1.5  2000/10/26 14:20:49  joergr
 *  Generalized routine to get and search for position strings ("1.2.3").
 *
 *  Revision 1.4  2000/10/18 17:09:06  joergr
 *  Made some functions inline.
 *
 *  Revision 1.3  2000/10/16 16:31:08  joergr
 *  Updated comments.
 *
 *  Revision 1.2  2000/10/16 11:57:00  joergr
 *  Added doc++ comments.
 *
 *  Revision 1.1  2000/10/13 07:49:34  joergr
 *  Added new module 'dcmsr' providing access to DICOM structured reporting
 *  documents (supplement 23).  Doc++ documentation not yet completed.
 *
 *
 */

---

Generated on 4 Nov 2004 for OFFIS DCMTK Version 3.5.3 by Doxygen 1.3.8