OFFIS DCMTK  Version 3.6.0
dsrcitem.h
1 /*
2  *
3  * Copyright (C) 2000-2010, OFFIS e.V.
4  * All rights reserved. See COPYRIGHT file for details.
5  *
6  * This software and supporting documentation were developed by
7  *
8  * OFFIS e.V.
9  * R&D Division Health
10  * Escherweg 2
11  * D-26121 Oldenburg, Germany
12  *
13  *
14  * Module: dcmsr
15  *
16  * Author: Joerg Riesmeier
17  *
18  * Purpose:
19  * classes: DSRContentItem
20  *
21  * Last Update: $Author: joergr $
22  * Update Date: $Date: 2010-10-14 13:16:32 $
23  * CVS/RCS Revision: $Revision: 1.19 $
24  * Status: $State: Exp $
25  *
26  * CVS/RCS Log at end of file
27  *
28  */
29 
30 
31 #ifndef DSRCITEM_H
32 #define DSRCITEM_H
33 
34 #include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
35 
36 #include "dcmtk/dcmsr/dsrtypes.h"
37 #include "dcmtk/dcmsr/dsrdoctn.h"
38 #include "dcmtk/dcmsr/dsrcodvl.h"
39 #include "dcmtk/dcmsr/dsrnumvl.h"
40 #include "dcmtk/dcmsr/dsrscovl.h"
41 #include "dcmtk/dcmsr/dsrtcovl.h"
42 #include "dcmtk/dcmsr/dsrcomvl.h"
43 #include "dcmtk/dcmsr/dsrimgvl.h"
44 #include "dcmtk/dcmsr/dsrwavvl.h"
45 
46 #include "dcmtk/ofstd/ofstring.h"
47 
48 
49 /*---------------------*
50  * class declaration *
51  *---------------------*/
52 
57  : protected DSRTypes
58 {
59  // allow DSRDocumentTree to access protected method setTreeNode()
60  friend class DSRDocumentTree;
61 
62  public:
63 
66  virtual ~DSRContentItem();
67 
72  OFBool isValid() const;
73 
78  OFBool isMarked() const;
79 
84  void setMark(const OFBool flag);
85 
90  E_ValueType getValueType() const;
91 
97 
102  size_t getReferencedNodeID() const;
103 
108  const OFString &getStringValue() const;
109 
116  OFCondition setStringValue(const OFString &stringValue);
117 
123 
128  const DSRCodedEntryValue &getCodeValue() const;
129 
135  OFCondition getCodeValue(DSRCodedEntryValue &codeValue) const;
136 
142  OFCondition setCodeValue(const DSRCodedEntryValue &codeValue);
143 
149 
155 
162 
169 
175 
181 
188 
195 
201 
207 
214 
221 
227 
233 
240 
247 
253 
259 
266 
273 
279 
285 
292 
299 
307 
315  OFCondition setContinuityOfContent(const E_ContinuityOfContent continuityOfContent);
316 
324 
331  const DSRCodedEntryValue &getConceptName() const;
332 
340  OFCondition getConceptName(DSRCodedEntryValue &conceptName) const;
341 
349  OFCondition setConceptName(const DSRCodedEntryValue &conceptName);
350 
357  const OFString &getObservationDateTime() const;
358 
367  OFCondition setObservationDateTime(const OFString &observationDateTime);
368 
382  OFCondition getTemplateIdentification(OFString &templateIdentifier,
383  OFString &mappingResource) const;
384 
393  OFCondition setTemplateIdentification(const OFString &templateIdentifier,
394  const OFString &mappingResource);
395 
396 
397  protected:
398 
401  DSRContentItem();
402 
406  inline void setTreeNode(DSRDocumentTreeNode *node)
407  {
408  TreeNode = node;
409  }
410 
411 
412  private:
413 
416 
418  static const OFString EmptyString;
433 
434 
435  // --- declaration of copy constructor and assignment operator
436 
438  DSRContentItem &operator=(const DSRContentItem &);
439 };
440 
441 
442 #endif
443 
444 
445 /*
446  * CVS/RCS Log:
447  * $Log: dsrcitem.h,v $
448  * Revision 1.19 2010-10-14 13:16:32 joergr
449  * Updated copyright header. Added reference to COPYRIGHT file.
450  *
451  * Revision 1.18 2005-12-08 16:04:50 meichel
452  * Changed include path schema for all DCMTK header files
453  *
454  * Revision 1.17 2003/12/16 15:57:51 joergr
455  * Added note that the condition for the Content Template Sequence is currently
456  * not checked.
457  *
458  * Revision 1.16 2003/10/30 17:54:09 joergr
459  * Added full support for the ContentTemplateSequence (read/write, get/set
460  * template identification). Template constraints are not checked yet.
461  *
462  * Revision 1.15 2003/08/07 12:18:57 joergr
463  * Updated documentation to get rid of doxygen warnings.
464  *
465  * Revision 1.14 2001/09/26 13:04:04 meichel
466  * Adapted dcmsr to class OFCondition
467  *
468  * Revision 1.13 2001/05/07 16:13:23 joergr
469  * Updated CVS header.
470  *
471  * Revision 1.12 2001/01/18 15:53:32 joergr
472  * Added support for digital signatures.
473  *
474  * Revision 1.11 2000/11/13 14:19:05 joergr
475  * Updated comments.
476  *
477  * Revision 1.10 2000/11/07 18:11:29 joergr
478  * Enhanced support for by-reference relationships.
479  *
480  * Revision 1.9 2000/11/01 16:11:26 joergr
481  * Now derive "protected" from base class DSRTypes instead of "public".
482  *
483  * Revision 1.8 2000/10/26 14:16:18 joergr
484  * Added support for "Comprehensive SR".
485  * Added support for TCOORD content item.
486  *
487  * Revision 1.7 2000/10/23 15:06:37 joergr
488  * Added/updated doc++ comments.
489  *
490  * Revision 1.6 2000/10/20 10:15:42 joergr
491  * Renamed class DSRReferenceValue to DSRCompositeReferenceValue.
492  *
493  * Revision 1.5 2000/10/18 16:58:27 joergr
494  * Added methods allowing direct access to certain content item values.
495  *
496  * Revision 1.4 2000/10/17 12:34:31 joergr
497  * Added method checking content item for validity/completeness.
498  * Renamed methods for composite objects.
499  *
500  * Revision 1.3 2000/10/16 16:29:36 joergr
501  * Updated comments.
502  *
503  * Revision 1.2 2000/10/16 11:55:40 joergr
504  * Added doc++ comments.
505  * Added methods allowing direct access to certain content item values.
506  *
507  * Revision 1.1 2000/10/13 07:49:23 joergr
508  * Added new module 'dcmsr' providing access to DICOM structured reporting
509  * documents (supplement 23). Doc++ documentation not yet completed.
510  *
511  *
512  */
Interface class for content items.
Definition: dsrcitem.h:56
DSRCodedEntryValue * getCodeValuePtr()
get pointer to code value.
OFBool isMarked() const
check for mark flag.
Class for spatial coordinate values.
Definition: dsrscovl.h:46
const DSRNumericMeasurementValue & getNumericValue() const
get numeric value.
static const DSRSpatialCoordinatesValue EmptySpatialCoordinates
empty spatial coordinates value. Used as default return value for getSpatialCoordinates() ...
Definition: dsrcitem.h:424
DSRContentItem()
default constructor (protected)
Class for image reference values.
Definition: dsrimgvl.h:47
OFCondition setContinuityOfContent(const E_ContinuityOfContent continuityOfContent)
set continuity of content flag.
const DSRTemporalCoordinatesValue & getTemporalCoordinates() const
get temporal coordinates.
E_ValueType getValueType() const
get value type.
E_ContinuityOfContent
SR continuity of content flag.
Definition: dsrtypes.h:533
Class managing the SR document tree.
Definition: dsrdoctr.h:56
OFCondition getTemplateIdentification(OFString &templateIdentifier, OFString &mappingResource) const
get template identifier and mapping resource.
E_RelationshipType
SR relationship types.
Definition: dsrtypes.h:393
OFCondition setNumericValue(const DSRNumericMeasurementValue &numericValue)
set numeric value.
E_ContinuityOfContent getContinuityOfContent() const
get continuity of content flag.
OFCondition setSpatialCoordinates(const DSRSpatialCoordinatesValue &coordinatesValue)
set spatial coordinates.
DSRImageReferenceValue * getImageReferencePtr()
get pointer to image reference.
const DSRImageReferenceValue & getImageReference() const
get image reference.
DSRNumericMeasurementValue * getNumericValuePtr()
get pointer to numeric value.
OFCondition setImageReference(const DSRImageReferenceValue &referenceValue)
set image reference.
const DSRCompositeReferenceValue & getCompositeReference() const
get composite reference.
const OFString & getObservationDateTime() const
get observation date time.
Class for waveform reference values.
Definition: dsrwavvl.h:47
DSRTemporalCoordinatesValue * getTemporalCoordinatesPtr()
get pointer to temporal coordinates.
Class for spatial coordinate values.
Definition: dsrtcovl.h:48
OFCondition setStringValue(const OFString &stringValue)
set string value.
size_t getReferencedNodeID() const
get ID of the referenced node.
Class for coded entry values.
Definition: dsrcodvl.h:47
static const DSRCompositeReferenceValue EmptyCompositeReference
empty composite reference value. Used as default return value for getCompositeReference() ...
Definition: dsrcitem.h:428
OFCondition setCompositeReference(const DSRCompositeReferenceValue &referenceValue)
set composite reference.
virtual ~DSRContentItem()
destructor
E_ValueType
SR value types.
Definition: dsrtypes.h:421
const DSRSpatialCoordinatesValue & getSpatialCoordinates() const
get spatial coordinates.
const DSRCodedEntryValue & getConceptName() const
get concept name.
OFCondition setTemplateIdentification(const OFString &templateIdentifier, const OFString &mappingResource)
set template identifier and mapping resource.
static const DSRCodedEntryValue EmptyCodedEntry
empty coded entry value. Used as default return value for getCodeValue() and getConceptName() ...
Definition: dsrcitem.h:420
Class for composite reference values.
Definition: dsrcomvl.h:47
static const DSRImageReferenceValue EmptyImageReference
empty image reference value. Used as default return value for getImageReference() ...
Definition: dsrcitem.h:430
static const DSRTemporalCoordinatesValue EmptyTemporalCoordinates
empty temporal coordinates value. Used as default return value for getTemporalCoordinates() ...
Definition: dsrcitem.h:426
const OFString & getStringValue() const
get string value.
Base class for content items.
Definition: dsrdoctn.h:54
Class for numeric measurement values.
Definition: dsrnumvl.h:47
OFCondition setConceptName(const DSRCodedEntryValue &conceptName)
set concept name.
OFBool isValid() const
check for validity/completeness.
General purpose class hiding global functions, constants and types from the global namespace...
Definition: dsrtypes.h:150
const DSRWaveformReferenceValue & getWaveformReference() const
get waveform reference.
a simple string class that implements a subset of std::string.
Definition: ofstring.h:86
OFCondition setTemporalCoordinates(const DSRTemporalCoordinatesValue &coordinatesValue)
set temporal coordinates.
DSRCompositeReferenceValue * getCompositeReferencePtr()
get pointer to composite reference.
DSRSpatialCoordinatesValue * getSpatialCoordinatesPtr()
get pointer to spatial coordinates.
OFCondition setCodeValue(const DSRCodedEntryValue &codeValue)
set code value.
const DSRCodedEntryValue & getCodeValue() const
get code value.
OFCondition setWaveformReference(const DSRWaveformReferenceValue &referenceValue)
set waveform reference.
DSRDocumentTreeNode * TreeNode
internal tree node pointer (current conten item)
Definition: dsrcitem.h:415
static const OFString EmptyString
empty string value. Used as default return value for getStringValue()
Definition: dsrcitem.h:418
static const DSRWaveformReferenceValue EmptyWaveformReference
empty waveform reference value. Used as default return value for getWaveformReference() ...
Definition: dsrcitem.h:432
static const DSRNumericMeasurementValue EmptyNumericMeasurement
empty numberic measurement value. Used as default return value for getNumericValue() ...
Definition: dsrcitem.h:422
E_RelationshipType getRelationshipType() const
get relationship type.
DSRCodedEntryValue * getConceptNamePtr()
get pointer to concept name.
void setTreeNode(DSRDocumentTreeNode *node)
set internal tree node pointer (protected)
Definition: dsrcitem.h:406
OFCondition setObservationDateTime(const OFString &observationDateTime)
set observation date time.
General purpose class for condition codes.
Definition: ofcond.h:305
void setMark(const OFBool flag)
mark/unmark item.
DSRWaveformReferenceValue * getWaveformReferencePtr()
get pointer to waveform reference.


Generated on Wed Dec 14 2016 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.11