dcmsr/include/dcmtk/dcmsr/dsrnumvl.h

00001 /*
00002  *
00003  *  Copyright (C) 2000-2010, OFFIS e.V.
00004  *  All rights reserved.  See COPYRIGHT file for details.
00005  *
00006  *  This software and supporting documentation were developed by
00007  *
00008  *    OFFIS e.V.
00009  *    R&D Division Health
00010  *    Escherweg 2
00011  *    D-26121 Oldenburg, Germany
00012  *
00013  *
00014  *  Module: dcmsr
00015  *
00016  *  Author: Joerg Riesmeier
00017  *
00018  *  Purpose:
00019  *    classes: DSRNumericMeasurementValue
00020  *
00021  *  Last Update:      $Author: joergr $
00022  *  Update Date:      $Date: 2010-10-14 13:16:32 $
00023  *  CVS/RCS Revision: $Revision: 1.15 $
00024  *  Status:           $State: Exp $
00025  *
00026  *  CVS/RCS Log at end of file
00027  *
00028  */
00029 
00030 
00031 #ifndef DSRNUMVL_H
00032 #define DSRNUMVL_H
00033 
00034 #include "dcmtk/config/osconfig.h"   /* make sure OS specific configuration is included first */
00035 
00036 #include "dcmtk/dcmsr/dsrcodvl.h"
00037 
00038 #include "dcmtk/ofstd/ofstring.h"
00039 
00040 
00041 /*---------------------*
00042  *  class declaration  *
00043  *---------------------*/
00044 
00047 class DSRNumericMeasurementValue
00048 {
00049     // allow access to getValuePtr()
00050     friend class DSRContentItem;
00051 
00052   public:
00053 
00056     DSRNumericMeasurementValue();
00057 
00064     DSRNumericMeasurementValue(const OFString &numericValue,
00065                                const DSRCodedEntryValue &measurementUnit);
00066 
00074     DSRNumericMeasurementValue(const OFString &numericValue,
00075                                const DSRCodedEntryValue &measurementUnit,
00076                                const DSRCodedEntryValue &valueQualifier);
00077 
00081     DSRNumericMeasurementValue(const DSRNumericMeasurementValue &numericMeasurement);
00082 
00085     virtual ~DSRNumericMeasurementValue();
00086 
00091     DSRNumericMeasurementValue &operator=(const DSRNumericMeasurementValue &numericMeasurement);
00092 
00096     virtual void clear();
00097 
00103     virtual OFBool isValid() const;
00104 
00109     virtual OFBool isEmpty() const;
00110 
00119     virtual OFCondition print(STD_NAMESPACE ostream &stream,
00120                               const size_t flags) const;
00121 
00127     virtual OFCondition readXML(const DSRXMLDocument &doc,
00128                                 DSRXMLCursor cursor);
00129 
00135     virtual OFCondition writeXML(STD_NAMESPACE ostream &stream,
00136                                  const size_t flags) const;
00137 
00145     virtual OFCondition readSequence(DcmItem &dataset);
00146 
00153     virtual OFCondition writeSequence(DcmItem &dataset) const;
00154 
00163     virtual OFCondition renderHTML(STD_NAMESPACE ostream &docStream,
00164                                    STD_NAMESPACE ostream &annexStream,
00165                                    size_t &annexNumber,
00166                                    const size_t flags) const;
00167 
00171     inline const DSRNumericMeasurementValue &getValue() const
00172     {
00173         return *this;
00174     }
00175 
00180     OFCondition getValue(DSRNumericMeasurementValue &numericMeasurement) const;
00181 
00185     inline const OFString &getNumericValue() const
00186     {
00187         return NumericValue;
00188     }
00189 
00193     inline const DSRCodedEntryValue &getMeasurementUnit() const
00194     {
00195         return MeasurementUnit;
00196     }
00197 
00201     inline const DSRCodedEntryValue &getNumericValueQualifier() const
00202     {
00203         return ValueQualifier;
00204     }
00205 
00210     OFCondition getMeasurementUnit(DSRCodedEntryValue &measurementUnit) const;
00211 
00218     OFCondition setValue(const DSRNumericMeasurementValue &numericMeasurement);
00219 
00227     OFCondition setValue(const OFString &numericValue,
00228                          const DSRCodedEntryValue &measurementUnit);
00229 
00239     OFCondition setValue(const OFString &numericValue,
00240                          const DSRCodedEntryValue &measurementUnit,
00241                          const DSRCodedEntryValue &valueQualifier);
00242 
00249     OFCondition setNumericValue(const OFString &numericValue);
00250 
00257     OFCondition setMeasurementUnit(const DSRCodedEntryValue &measurementUnit);
00258 
00267     OFCondition setNumericValueQualifier(const DSRCodedEntryValue &valueQualifier);
00268 
00269 
00270   protected:
00271 
00275     inline DSRNumericMeasurementValue *getValuePtr()
00276     {
00277         return this;
00278     }
00279 
00284     virtual OFCondition readItem(DcmItem &dataset);
00285 
00290     virtual OFCondition writeItem(DcmItem &dataset) const;
00291 
00298     virtual OFBool checkNumericValue(const OFString &numericValue) const;
00299 
00305     virtual OFBool checkMeasurementUnit(const DSRCodedEntryValue &measurementUnit) const;
00306 
00314     virtual OFBool checkNumericValueQualifier(const DSRCodedEntryValue &valueQualifier) const;
00315 
00316 
00317   private:
00318 
00320     OFString           NumericValue;
00322     DSRCodedEntryValue MeasurementUnit;
00324     DSRCodedEntryValue ValueQualifier;
00325 };
00326 
00327 
00328 #endif
00329 
00330 
00331 /*
00332  *  CVS/RCS Log:
00333  *  $Log: dsrnumvl.h,v $
00334  *  Revision 1.15  2010-10-14 13:16:32  joergr
00335  *  Updated copyright header. Added reference to COPYRIGHT file.
00336  *
00337  *  Revision 1.14  2009-10-13 14:57:50  uli
00338  *  Switched to logging mechanism provided by the "new" oflog module.
00339  *
00340  *  Revision 1.13  2007-11-15 16:33:30  joergr
00341  *  Added support for output in XHTML 1.1 format.
00342  *
00343  *  Revision 1.12  2006/08/15 16:40:03  meichel
00344  *  Updated the code in module dcmsr to correctly compile when
00345  *    all standard C++ classes remain in namespace std.
00346  *
00347  *  Revision 1.11  2006/05/11 09:18:21  joergr
00348  *  Moved containsExtendedCharacters() from dcmsr to dcmdata module.
00349  *
00350  *  Revision 1.10  2005/12/08 16:05:11  meichel
00351  *  Changed include path schema for all DCMTK header files
00352  *
00353  *  Revision 1.9  2004/11/22 16:39:09  meichel
00354  *  Added method that checks if the SR document contains non-ASCII characters
00355  *    in any of the strings affected by SpecificCharacterSet.
00356  *
00357  *  Revision 1.8  2003/08/07 12:43:44  joergr
00358  *  Added readXML functionality.
00359  *
00360  *  Revision 1.7  2002/12/10 13:20:07  joergr
00361  *  Added support for the Numeric Value Qualifier Code Sequence (introduced with
00362  *  CP 260).
00363  *
00364  *  Revision 1.6  2001/09/26 13:04:09  meichel
00365  *  Adapted dcmsr to class OFCondition
00366  *
00367  *  Revision 1.5  2001/06/01 15:51:02  meichel
00368  *  Updated copyright header
00369  *
00370  *  Revision 1.4  2000/11/06 11:17:40  joergr
00371  *  Moved some protected methods to public part.
00372  *
00373  *  Revision 1.3  2000/11/01 16:23:22  joergr
00374  *  Added support for conversion to XML.
00375  *
00376  *  Revision 1.2  2000/10/18 17:05:12  joergr
00377  *  Added methods allowing direct access to certain content item values.
00378  *  Added doc++ comments.
00379  *  Made some functions inline.
00380  *
00381  *  Revision 1.1  2000/10/13 07:49:29  joergr
00382  *  Added new module 'dcmsr' providing access to DICOM structured reporting
00383  *  documents (supplement 23).  Doc++ documentation not yet completed.
00384  *
00385  *
00386  */


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