dcmsr/include/dcmtk/dcmsr/dsrsc3vl.h

/*
 *
 *  Copyright (C) 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: DSRSpatialCoordinates3DValue
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:16:32 $
 *  CVS/RCS Revision: $Revision: 1.2 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DSRSC3VL_H
#define DSRSC3VL_H

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

#include "dcmtk/dcmsr/dsrtypes.h"
#include "dcmtk/dcmsr/dsrsc3gr.h"


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

class DSRSpatialCoordinates3DValue
{
    // allow access to getValuePtr()
    friend class DSRContentItem;

  public:

    DSRSpatialCoordinates3DValue();

    DSRSpatialCoordinates3DValue(const DSRTypes::E_GraphicType3D graphicType);

    DSRSpatialCoordinates3DValue(const DSRSpatialCoordinates3DValue &coordinatesValue);

    virtual ~DSRSpatialCoordinates3DValue();

    DSRSpatialCoordinates3DValue &operator=(const DSRSpatialCoordinates3DValue &coordinatesValue);

    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 read(DcmItem &dataset);

    virtual OFCondition write(DcmItem &dataset) 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 DSRSpatialCoordinates3DValue &getValue() const
    {
        return *this;
    }

    inline DSRTypes::E_GraphicType3D getGraphicType() const
    {
        return GraphicType;
    }

    OFCondition setGraphicType(const DSRTypes::E_GraphicType3D graphicType);

    inline const OFString &getFrameOfReferenceUID() const
    {
        return FrameOfReferenceUID;
    }

    OFCondition setFrameOfReferenceUID(const OFString &frameOfReferenceUID);

    OFCondition getValue(DSRSpatialCoordinates3DValue &coordinatesValue) const;

    OFCondition setValue(const DSRSpatialCoordinates3DValue &coordinatesValue);

    inline DSRGraphicData3DList &getGraphicDataList()
    {
        return GraphicDataList;
    }


  protected:

    inline DSRSpatialCoordinates3DValue *getValuePtr()
    {
        return this;
    }

    OFBool checkData(const DSRTypes::E_GraphicType3D graphicType,
                     const DSRGraphicData3DList &graphicDataList,
                     const OFString &frameOfReferenceUID) const;


  private:

    DSRTypes::E_GraphicType3D GraphicType;
    DSRGraphicData3DList      GraphicDataList;
    OFString                  FrameOfReferenceUID;
};


#endif


/*
 *  CVS/RCS Log:
 *  $Log: dsrsc3vl.h,v $
 *  Revision 1.2  2010-10-14 13:16:32  joergr
 *  Updated copyright header. Added reference to COPYRIGHT file.
 *
 *  Revision 1.1  2010-09-28 14:08:14  joergr
 *  Added support for Colon CAD SR which requires a new value type (SCOORD3D).
 *
 *
 */

---

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