dsrsoprf.h

/*
 *
 *  Copyright (C) 2002-2005, 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: DSRSOPInstanceReferenceList
 *             - InstanceStruct, SeriesStruct, StudyStruct
 *
 *  Last Update:      $Author: meichel $
 *  Update Date:      $Date: 2005/12/08 16:05:18 $
 *  CVS/RCS Revision: $Revision: 1.9 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DSRSOPRF_H
#define DSRSOPRF_H

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

#include "dcmtk/ofstd/oflist.h"
#include "dcmtk/ofstd/ofstring.h"
#include "dcmtk/ofstd/ofconsol.h"
#include "dcmtk/ofstd/ofcond.h"

#include "dcmtk/dcmdata/dcitem.h"
#include "dcmtk/dcmdata/dctagkey.h"

#include "dcmtk/dcmsr/dsrtypes.h"


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

class DSRSOPInstanceReferenceList
  : public DSRTypes
{

  public:

    struct InstanceStruct
    {
        InstanceStruct(const OFString &sopClassUID,
                       const OFString &instanceUID);

        const OFString SOPClassUID;
        const OFString InstanceUID;
    };

    struct SeriesStruct
    {
        SeriesStruct(const OFString &seriesUID);

        ~SeriesStruct();

        size_t getNumberOfInstances() const;

        OFCondition read(DcmItem &dataset,
                         OFConsole *logStream);

        OFCondition write(DcmItem &dataset,
                          OFConsole *logStream) const;

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

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

        InstanceStruct *gotoInstance(const OFString &instanceUID);

        OFCondition gotoFirstItem();

        OFCondition gotoNextItem();

        OFCondition addItem(const OFString &sopClassUID,
                            const OFString &instanceUID);

        OFCondition removeItem();

        OFBool containsExtendedCharacters();

        const OFString SeriesUID;
        OFString RetrieveAETitle;
        OFString StorageMediaFileSetID;
        OFString StorageMediaFileSetUID;

        OFList<InstanceStruct *> InstanceList;
        OFListIterator(InstanceStruct *) Iterator;
    };

    struct StudyStruct
    {
        StudyStruct(const OFString &studyUID);

        ~StudyStruct();

        size_t getNumberOfInstances() const;

        OFCondition read(DcmItem &dataset,
                         OFConsole *logStream);

        OFCondition write(DcmItem &dataset,
                          OFConsole *logStream) const;

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

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

        SeriesStruct *gotoSeries(const OFString &seriesUID);

        InstanceStruct *gotoInstance(const OFString &instanceUID);

        OFCondition gotoFirstItem();

        OFCondition gotoNextItem();

        OFCondition addItem(const OFString &seriesUID,
                            const OFString &sopClassUID,
                            const OFString &instanceUID);

        OFCondition removeItem();

        void removeIncompleteItems();

        OFBool containsExtendedCharacters();

        const OFString StudyUID;

        OFList<SeriesStruct *> SeriesList;
        OFListIterator(SeriesStruct *) Iterator;
    };


    DSRSOPInstanceReferenceList(const DcmTagKey &sequence);

    ~DSRSOPInstanceReferenceList();

    void clear();

    OFBool empty() const;

    size_t getNumberOfInstances() const;

    OFCondition read(DcmItem &dataset,
                     OFConsole *logStream);

    OFCondition write(DcmItem &dataset,
                      OFConsole *logStream) const;

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

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

    OFCondition addItem(const OFString &studyUID,
                        const OFString &seriesUID,
                        const OFString &sopClassUID,
                        const OFString &instanceUID);

    OFCondition addItem(DcmItem &dataset);

    OFCondition removeItem();

    OFCondition removeItem(const OFString &sopClassUID,
                           const OFString &instanceUID);

    OFCondition removeItem(const OFString &studyUID,
                           const OFString &seriesUID,
                           const OFString &instanceUID);

    OFCondition gotoItem(const OFString &sopClassUID,
                         const OFString &instanceUID);

    OFCondition gotoItem(const OFString &studyUID,
                         const OFString &seriesUID,
                         const OFString &instanceUID);

    OFCondition gotoFirstItem();

    OFCondition gotoNextItem();

    const OFString &getStudyInstanceUID(OFString &stringValue) const;

    const OFString &getSeriesInstanceUID(OFString &stringValue) const;

    const OFString &getSOPInstanceUID(OFString &stringValue) const;

    const OFString &getSOPClassUID(OFString &stringValue) const;

    const OFString &getRetrieveAETitle(OFString &stringValue) const;

    const OFString &getStorageMediaFileSetID(OFString &stringValue) const;

    const OFString &getStorageMediaFileSetUID(OFString &stringValue) const;

    OFCondition setRetrieveAETitle(const OFString &value);

    OFCondition setStorageMediaFileSetID(const OFString &value);

    OFCondition setStorageMediaFileSetUID(const OFString &value);

    OFBool containsExtendedCharacters();

  protected:

    StudyStruct *gotoStudy(const OFString &studyUID);

    StudyStruct *getCurrentStudy() const;

    SeriesStruct *getCurrentSeries() const;

    InstanceStruct *getCurrentInstance() const;

    void removeIncompleteItems();


  private:

    const DcmTagKey SequenceTag;

    OFList<StudyStruct *> StudyList;
    OFListIterator(StudyStruct *) Iterator;

    // default constructor - not implemented!
    DSRSOPInstanceReferenceList();
    // copy constructor - not implemented!
    DSRSOPInstanceReferenceList(const DSRSOPInstanceReferenceList &);
    // assignment operator - not implemented!
    DSRSOPInstanceReferenceList &operator=(const DSRSOPInstanceReferenceList &);
};


#endif


/*
 *  CVS/RCS Log:
 *  $Log: dsrsoprf.h,v $
 *  Revision 1.9  2005/12/08 16:05:18  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.8  2005/07/27 16:33:39  joergr
 *  Added method that allows to add a DICOM dataset to the list of references.
 *
 *  Revision 1.7  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.6  2003/08/07 18:01:42  joergr
 *  Removed libxml dependency from header files.
 *
 *  Revision 1.5  2003/08/07 12:50:12  joergr
 *  Added readXML functionality.
 *  Renamed parameters/variables "string" to avoid name clash with STL class.
 *  Enhanced class DSRSOPInstanceReferenceList: empty/incomplete items (e.g.
 *  series with no instances or studies with no series) are automatically
 *  removed from the list.
 *
 *  Revision 1.4  2002/08/30 14:16:59  joergr
 *  Removed "friend" statements from class declaration and moved sub-classes to
 *  the "public" section (required for Sun CC 6).
 *
 *  Revision 1.3  2002/05/14 08:16:07  joergr
 *  Added removeItem() methods.
 *
 *  Revision 1.2  2002/05/07 14:04:44  joergr
 *  Added "friend" statements to class declaration (required for MSVC).
 *
 *  Revision 1.1  2002/05/07 12:49:31  joergr
 *  Added support for the Current Requested Procedure Evidence Sequence and the
 *  Pertinent Other Evidence Sequence to the dcmsr module.
 *
 *
 */

---

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