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


#ifndef DSRCITEM_H
#define DSRCITEM_H

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

#include "dcmtk/dcmsr/dsrtypes.h"
#include "dcmtk/dcmsr/dsrdoctn.h"
#include "dcmtk/dcmsr/dsrcodvl.h"
#include "dcmtk/dcmsr/dsrnumvl.h"
#include "dcmtk/dcmsr/dsrscovl.h"
#include "dcmtk/dcmsr/dsrtcovl.h"
#include "dcmtk/dcmsr/dsrcomvl.h"
#include "dcmtk/dcmsr/dsrimgvl.h"
#include "dcmtk/dcmsr/dsrwavvl.h"

#include "dcmtk/ofstd/ofstring.h"


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

class DSRContentItem
  : protected DSRTypes
{
    // allow DSRDocumentTree to access protected method setTreeNode()
    friend class DSRDocumentTree;

  public:

    virtual ~DSRContentItem();

    OFBool isValid() const;

    OFBool isMarked() const;

    void setMark(const OFBool flag);

    E_ValueType getValueType() const;

    E_RelationshipType getRelationshipType() const;

    size_t getReferencedNodeID() const;

    const OFString &getStringValue() const;

    OFCondition setStringValue(const OFString &stringValue);

    DSRCodedEntryValue *getCodeValuePtr();

    const DSRCodedEntryValue &getCodeValue() const;

    OFCondition getCodeValue(DSRCodedEntryValue &codeValue) const;

    OFCondition setCodeValue(const DSRCodedEntryValue &codeValue);

    DSRNumericMeasurementValue *getNumericValuePtr();

    const DSRNumericMeasurementValue &getNumericValue() const;

    OFCondition getNumericValue(DSRNumericMeasurementValue &numericValue) const;

    OFCondition setNumericValue(const DSRNumericMeasurementValue &numericValue);

    DSRSpatialCoordinatesValue *getSpatialCoordinatesPtr();

    const DSRSpatialCoordinatesValue &getSpatialCoordinates() const;

    OFCondition getSpatialCoordinates(DSRSpatialCoordinatesValue &coordinatesValue) const;

    OFCondition setSpatialCoordinates(const DSRSpatialCoordinatesValue &coordinatesValue);

    DSRTemporalCoordinatesValue *getTemporalCoordinatesPtr();

    const DSRTemporalCoordinatesValue &getTemporalCoordinates() const;

    OFCondition getTemporalCoordinates(DSRTemporalCoordinatesValue &coordinatesValue) const;

    OFCondition setTemporalCoordinates(const DSRTemporalCoordinatesValue &coordinatesValue);

    DSRCompositeReferenceValue *getCompositeReferencePtr();

    const DSRCompositeReferenceValue &getCompositeReference() const;

    OFCondition getCompositeReference(DSRCompositeReferenceValue &referenceValue) const;

    OFCondition setCompositeReference(const DSRCompositeReferenceValue &referenceValue);

    DSRImageReferenceValue *getImageReferencePtr();

    const DSRImageReferenceValue &getImageReference() const;

    OFCondition getImageReference(DSRImageReferenceValue &referenceValue) const;

    OFCondition setImageReference(const DSRImageReferenceValue &referenceValue);

    DSRWaveformReferenceValue *getWaveformReferencePtr();

    const DSRWaveformReferenceValue &getWaveformReference() const;

    OFCondition getWaveformReference(DSRWaveformReferenceValue &referenceValue) const;

    OFCondition setWaveformReference(const DSRWaveformReferenceValue &referenceValue);

    E_ContinuityOfContent getContinuityOfContent() const;

    OFCondition setContinuityOfContent(const E_ContinuityOfContent continuityOfContent);

    DSRCodedEntryValue *getConceptNamePtr();

    const DSRCodedEntryValue &getConceptName() const;

    OFCondition getConceptName(DSRCodedEntryValue &conceptName) const;

    OFCondition setConceptName(const DSRCodedEntryValue &conceptName);

    const OFString &getObservationDateTime() const;

    OFCondition setObservationDateTime(const OFString &observationDateTime);

    OFCondition getTemplateIdentification(OFString &templateIdentifier,
                                          OFString &mappingResource) const;

    OFCondition setTemplateIdentification(const OFString &templateIdentifier,
                                          const OFString &mappingResource);


  protected:

    DSRContentItem();

    inline void setTreeNode(DSRDocumentTreeNode *node)
    {
        TreeNode = node;
    }


  private:

    DSRDocumentTreeNode *TreeNode;

    static const OFString                    EmptyString;
    static const DSRCodedEntryValue          EmptyCodedEntry;
    static const DSRNumericMeasurementValue  EmptyNumericMeasurement;
    static const DSRSpatialCoordinatesValue  EmptySpatialCoordinates;
    static const DSRTemporalCoordinatesValue EmptyTemporalCoordinates;
    static const DSRCompositeReferenceValue  EmptyCompositeReference;
    static const DSRImageReferenceValue      EmptyImageReference;
    static const DSRWaveformReferenceValue   EmptyWaveformReference;


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

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


#endif


/*
 *  CVS/RCS Log:
 *  $Log: dsrcitem.h,v $
 *  Revision 1.19  2010-10-14 13:16:32  joergr
 *  Updated copyright header. Added reference to COPYRIGHT file.
 *
 *  Revision 1.18  2005-12-08 16:04:50  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.17  2003/12/16 15:57:51  joergr
 *  Added note that the condition for the Content Template Sequence is currently
 *  not checked.
 *
 *  Revision 1.16  2003/10/30 17:54:09  joergr
 *  Added full support for the ContentTemplateSequence (read/write, get/set
 *  template identification). Template constraints are not checked yet.
 *
 *  Revision 1.15  2003/08/07 12:18:57  joergr
 *  Updated documentation to get rid of doxygen warnings.
 *
 *  Revision 1.14  2001/09/26 13:04:04  meichel
 *  Adapted dcmsr to class OFCondition
 *
 *  Revision 1.13  2001/05/07 16:13:23  joergr
 *  Updated CVS header.
 *
 *  Revision 1.12  2001/01/18 15:53:32  joergr
 *  Added support for digital signatures.
 *
 *  Revision 1.11  2000/11/13 14:19:05  joergr
 *  Updated comments.
 *
 *  Revision 1.10  2000/11/07 18:11:29  joergr
 *  Enhanced support for by-reference relationships.
 *
 *  Revision 1.9  2000/11/01 16:11:26  joergr
 *  Now derive "protected" from base class DSRTypes instead of "public".
 *
 *  Revision 1.8  2000/10/26 14:16:18  joergr
 *  Added support for "Comprehensive SR".
 *  Added support for TCOORD content item.
 *
 *  Revision 1.7  2000/10/23 15:06:37  joergr
 *  Added/updated doc++ comments.
 *
 *  Revision 1.6  2000/10/20 10:15:42  joergr
 *  Renamed class DSRReferenceValue to DSRCompositeReferenceValue.
 *
 *  Revision 1.5  2000/10/18 16:58:27  joergr
 *  Added methods allowing direct access to certain content item values.
 *
 *  Revision 1.4  2000/10/17 12:34:31  joergr
 *  Added method checking content item for validity/completeness.
 *  Renamed methods for composite objects.
 *
 *  Revision 1.3  2000/10/16 16:29:36  joergr
 *  Updated comments.
 *
 *  Revision 1.2  2000/10/16 11:55:40  joergr
 *  Added doc++ comments.
 *  Added methods allowing direct access to certain content item values.
 *
 *  Revision 1.1  2000/10/13 07:49:23  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