dcmsr/include/dcmtk/dcmsr/dsrimgvl.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: DSRImageReferenceValue
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:16:32 $
 *  CVS/RCS Revision: $Revision: 1.17 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DSRIMGVL_H
#define DSRIMGVL_H

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

#include "dcmtk/dcmsr/dsrtypes.h"
#include "dcmtk/dcmsr/dsrcomvl.h"
#include "dcmtk/dcmsr/dsrimgfr.h"


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

class DSRImageReferenceValue
  : public DSRCompositeReferenceValue
{
    // allow access to getValuePtr()
    friend class DSRContentItem;

  public:

    DSRImageReferenceValue();

    DSRImageReferenceValue(const OFString &sopClassUID,
                           const OFString &sopInstanceUID);

    DSRImageReferenceValue(const OFString &imageSOPClassUID,
                           const OFString &imageSOPInstanceUID,
                           const OFString &pstateSOPClassUID,
                           const OFString &pstateSOPInstanceUID);

    DSRImageReferenceValue(const DSRImageReferenceValue &referenceValue);

    DSRImageReferenceValue(const DSRCompositeReferenceValue &imageReferenceValue,
                           const DSRCompositeReferenceValue &pstateReferenceValue);

    virtual ~DSRImageReferenceValue();

    DSRImageReferenceValue &operator=(const DSRImageReferenceValue &referenceValue);

    virtual void clear();

    virtual OFBool isValid() const;

    virtual OFBool isShort(const size_t flags) const;

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

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

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

    virtual OFCondition renderHTML(STD_NAMESPACE ostream &docStream,
                                   STD_NAMESPACE ostream &annexStream,
                                   size_t &annexNumber,
                                   const size_t flags) const;

    inline const DSRImageReferenceValue &getValue() const
    {
        return *this;
    }

    OFCondition getValue(DSRImageReferenceValue &referenceValue) const;

    OFCondition setValue(const DSRImageReferenceValue &referenceValue);

    inline const DSRCompositeReferenceValue &getPresentationState() const
    {
        return PresentationState;
    }

    OFCondition setPresentationState(const DSRCompositeReferenceValue &referenceValue);

    inline DSRImageFrameList &getFrameList()
    {
        return FrameList;
    }

    OFBool appliesToFrame(const Sint32 frameNumber) const;


  protected:

    inline DSRImageReferenceValue *getValuePtr()
    {
        return this;
    }

    virtual OFCondition readItem(DcmItem &dataset);

    virtual OFCondition writeItem(DcmItem &dataset) const;

    virtual OFBool checkSOPClassUID(const OFString &sopClassUID) const;

    OFBool checkPresentationState(const DSRCompositeReferenceValue &referenceValue) const;


  private:

    DSRCompositeReferenceValue PresentationState;
    DSRImageFrameList FrameList;
    
    /* IconImageSequence (Type 3) not yet supported */
};


#endif


/*
 *  CVS/RCS Log:
 *  $Log: dsrimgvl.h,v $
 *  Revision 1.17  2010-10-14 13:16:32  joergr
 *  Updated copyright header. Added reference to COPYRIGHT file.
 *
 *  Revision 1.16  2009-10-13 14:57:50  uli
 *  Switched to logging mechanism provided by the "new" oflog module.
 *
 *  Revision 1.15  2007-11-15 16:33:30  joergr
 *  Added support for output in XHTML 1.1 format.
 *
 *  Revision 1.14  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.13  2005/12/08 16:05:06  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.12  2003/10/06 09:52:35  joergr
 *  Added comment that the optional IconImageSequence is not yet supported.
 *
 *  Revision 1.11  2003/08/07 18:01:42  joergr
 *  Removed libxml dependency from header files.
 *
 *  Revision 1.10  2003/08/07 12:42:38  joergr
 *  Added readXML functionality.
 *
 *  Revision 1.9  2001/09/26 13:04:09  meichel
 *  Adapted dcmsr to class OFCondition
 *
 *  Revision 1.8  2001/06/01 15:51:01  meichel
 *  Updated copyright header
 *
 *  Revision 1.7  2000/11/06 11:17:21  joergr
 *  Moved some protected methods to public part.
 *
 *  Revision 1.6  2000/11/01 16:23:21  joergr
 *  Added support for conversion to XML.
 *
 *  Revision 1.5  2000/10/26 14:18:27  joergr
 *  Updated comments.
 *
 *  Revision 1.4  2000/10/20 10:15:42  joergr
 *  Renamed class DSRReferenceValue to DSRCompositeReferenceValue.
 *
 *  Revision 1.3  2000/10/18 17:04:23  joergr
 *  Added methods allowing direct access to certain content item values.
 *  Added doc++ comments.
 *
 *  Revision 1.2  2000/10/16 11:54:12  joergr
 *  Added new method checking whether an image content item applies to a
 *  certain frame.
 *
 *  Revision 1.1  2000/10/13 07:49:28  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