dcmsr/include/dcmtk/dcmsr/dsrdoctr.h

/*
 *
 *  Copyright (C) 2000-2010, OFFIS e.V.
 *  All rights reserved.  See COPYRIGHT file for details.
 *
 *  This software and supporting documentation were developed by
 *
 *    OFFIS e.V.
 *    R&D Division Health
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *
 *  Module: dcmsr
 *
 *  Author: Joerg Riesmeier
 *
 *  Purpose:
 *    classes: DSRDocumentTree
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:16:32 $
 *  CVS/RCS Revision: $Revision: 1.23 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DSRDOCTR_H
#define DSRDOCTR_H

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

#include "dcmtk/dcmsr/dsrtree.h"
#include "dcmtk/dcmsr/dsrdoctn.h"
#include "dcmtk/dcmsr/dsrcitem.h"

#include "dcmtk/dcmdata/dcitem.h"


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

class DSRIODConstraintChecker;


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

class DSRDocumentTree
  : public DSRTree
{

  public:

    DSRDocumentTree(const E_DocumentType documentType);

    virtual ~DSRDocumentTree();

    virtual void clear();

    virtual OFBool isValid() const;

    OFCondition print(STD_NAMESPACE ostream &stream,
                      const size_t flags = 0);

    OFCondition read(DcmItem &dataset,
                     const E_DocumentType documentType,
                     const size_t flags = 0);

    OFCondition write(DcmItem &dataset,
                      DcmStack *markedItems = NULL);

    OFCondition readXML(const DSRXMLDocument &doc,
                        DSRXMLCursor cursor,
                        const size_t flags);

    OFCondition writeXML(STD_NAMESPACE ostream &stream,
                         const size_t flags);

    OFCondition renderHTML(STD_NAMESPACE ostream &docStream,
                           STD_NAMESPACE ostream &annexStream,
                           const size_t flags = 0);

    E_DocumentType getDocumentType() const
    {
        return DocumentType;
    }

    OFCondition changeDocumentType(const E_DocumentType documentType);

    OFBool canAddContentItem(const E_RelationshipType relationshipType,
                             const E_ValueType valueType,
                             const E_AddMode addMode = AM_afterCurrent);

    OFBool canAddByReferenceRelationship(const E_RelationshipType relationshipType,
                                         const E_ValueType targetValueType);

    size_t addContentItem(const E_RelationshipType relationshipType,
                          const E_ValueType valueType,
                          const E_AddMode addMode = AM_afterCurrent);

    size_t addByReferenceRelationship(const E_RelationshipType relationshipType,
                                      const size_t referencedNodeID);

    size_t removeCurrentContentItem();

    DSRContentItem &getCurrentContentItem();

    size_t gotoNamedNode(const DSRCodedEntryValue &conceptName,
                         const OFBool startFromRoot = OFTrue,
                         const OFBool searchIntoSub = OFTrue);

    size_t gotoNextNamedNode(const DSRCodedEntryValue &conceptName,
                             const OFBool searchIntoSub = OFTrue);

    void unmarkAllContentItems();

    void removeSignatures();


  protected:

    virtual size_t addNode(DSRDocumentTreeNode *node,
                           const E_AddMode addMode = AM_afterCurrent);

    virtual size_t removeNode();

    OFCondition checkByReferenceRelationships(const size_t mode = 0,
                                              const size_t flags = 0);

    void resetReferenceTargetFlag();


  private:

    virtual size_t addNode(DSRTreeNode *node,
                           const E_AddMode addMode = AM_afterCurrent);

    E_DocumentType DocumentType;
    DSRContentItem CurrentContentItem;
    DSRIODConstraintChecker *ConstraintChecker;


 // --- declaration of default/copy constructor and assignment operator

    DSRDocumentTree();
    DSRDocumentTree(const DSRDocumentTree &);
    DSRDocumentTree &operator=(const DSRDocumentTree &);
};


#endif


/*
 *  CVS/RCS Log:
 *  $Log: dsrdoctr.h,v $
 *  Revision 1.23  2010-10-14 13:16:32  joergr
 *  Updated copyright header. Added reference to COPYRIGHT file.
 *
 *  Revision 1.22  2009-10-13 14:57:50  uli
 *  Switched to logging mechanism provided by the "new" oflog module.
 *
 *  Revision 1.21  2008-05-19 09:46:40  joergr
 *  Reset flag for all content items whether they are target of a by-reference
 *  relationship (required for an reproducible behavior).
 *  Changed parameters of checkByReferenceRelationships() method.
 *
 *  Revision 1.20  2007/11/15 16:33:30  joergr
 *  Added support for output in XHTML 1.1 format.
 *
 *  Revision 1.19  2007/05/11 14:50:05  joergr
 *  Enhanced debug output when detecting by-reference relationships to non-
 *  existing content items.
 *
 *  Revision 1.18  2006/08/15 16:40:03  meichel
 *  Updated the code in module dcmsr to correctly compile when
 *    all standard C++ classes remain in namespace std.
 *
 *  Revision 1.17  2006/05/11 09:18:21  joergr
 *  Moved containsExtendedCharacters() from dcmsr to dcmdata module.
 *
 *  Revision 1.16  2005/12/08 16:05:01  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.15  2005/07/27 16:36:38  joergr
 *  Added methods that allow to go to a named node, i.e. using a given concept
 *  name.
 *
 *  Revision 1.14  2004/11/22 16:39:09  meichel
 *  Added method that checks if the SR document contains non-ASCII characters
 *    in any of the strings affected by SpecificCharacterSet.
 *
 *  Revision 1.13  2003/09/15 14:18:54  joergr
 *  Introduced new class to facilitate checking of SR IOD relationship content
 *  constraints. Replaced old implementation distributed over numerous classes.
 *
 *  Revision 1.12  2003/08/07 12:35:27  joergr
 *  Added readXML functionality.
 *  Updated documentation to get rid of doxygen warnings.
 *
 *  Revision 1.11  2002/04/11 13:02:34  joergr
 *  Corrected typo and/or enhanced documentation.
 *
 *  Revision 1.10  2001/11/09 16:10:49  joergr
 *  Added preliminary support for Mammography CAD SR.
 *
 *  Revision 1.9  2001/09/26 13:04:07  meichel
 *  Adapted dcmsr to class OFCondition
 *
 *  Revision 1.8  2001/04/03 08:24:01  joergr
 *  Added new command line option: ignore relationship content constraints
 *  specified for each SR document class.
 *
 *  Revision 1.7  2001/01/25 11:48:43  joergr
 *  Corrected typos / enhanced comments.
 *
 *  Revision 1.6  2001/01/18 15:53:34  joergr
 *  Added support for digital signatures.
 *
 *  Revision 1.5  2000/11/07 18:14:29  joergr
 *  Enhanced support for by-reference relationships.
 *
 *  Revision 1.4  2000/11/01 16:23:20  joergr
 *  Added support for conversion to XML.
 *
 *  Revision 1.3  2000/10/18 17:02:57  joergr
 *  Added doc++ comments.
 *
 *  Revision 1.2  2000/10/16 16:31:45  joergr
 *  Added doc++ comments.
 *
 *  Revision 1.1  2000/10/13 07:49:26  joergr
 *  Added new module 'dcmsr' providing access to DICOM structured reporting
 *  documents (supplement 23).  Doc++ documentation not yet completed.
 *
 *
 */

---

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1