dsrnumvl.h

/*
 *
 *  Copyright (C) 2000-2005, OFFIS
 *
 *  This software and supporting documentation were developed by
 *
 *    Kuratorium OFFIS e.V.
 *    Healthcare Information and Communication Systems
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *  THIS SOFTWARE IS MADE AVAILABLE,  AS IS,  AND OFFIS MAKES NO  WARRANTY
 *  REGARDING  THE  SOFTWARE,  ITS  PERFORMANCE,  ITS  MERCHANTABILITY  OR
 *  FITNESS FOR ANY PARTICULAR USE, FREEDOM FROM ANY COMPUTER DISEASES  OR
 *  ITS CONFORMITY TO ANY SPECIFICATION. THE ENTIRE RISK AS TO QUALITY AND
 *  PERFORMANCE OF THE SOFTWARE IS WITH THE USER.
 *
 *  Module: dcmsr
 *
 *  Author: Joerg Riesmeier
 *
 *  Purpose:
 *    classes: DSRNumericMeasurementValue
 *
 *  Last Update:      $Author: meichel $
 *  Update Date:      $Date: 2005/12/08 16:05:11 $
 *  CVS/RCS Revision: $Revision: 1.10 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */


#ifndef DSRNUMVL_H
#define DSRNUMVL_H

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

#include "dcmtk/dcmsr/dsrcodvl.h"

#include "dcmtk/ofstd/ofstring.h"


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

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

  public:

    DSRNumericMeasurementValue();

    DSRNumericMeasurementValue(const OFString &numericValue,
                               const DSRCodedEntryValue &measurementUnit);

    DSRNumericMeasurementValue(const OFString &numericValue,
                               const DSRCodedEntryValue &measurementUnit,
                               const DSRCodedEntryValue &valueQualifier);

    DSRNumericMeasurementValue(const DSRNumericMeasurementValue &numericMeasurement);

    virtual ~DSRNumericMeasurementValue();

    DSRNumericMeasurementValue &operator=(const DSRNumericMeasurementValue &numericMeasurement);

    virtual void clear();

    virtual OFBool isValid() const;

    virtual OFBool isEmpty() const;

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

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

    virtual OFCondition writeXML(ostream &stream,
                                 const size_t flags,
                                 OFConsole *logStream) const;

    virtual OFCondition readSequence(DcmItem &dataset,
                                     OFConsole *logStream);

    virtual OFCondition writeSequence(DcmItem &dataset,
                                      OFConsole *logStream) const;

    virtual OFCondition renderHTML(ostream &docStream,
                                   ostream &annexStream,
                                   size_t &annexNumber,
                                   const size_t flags,
                                   OFConsole *logStream) const;

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

    OFCondition getValue(DSRNumericMeasurementValue &numericMeasurement) const;

    inline const OFString &getNumericValue() const
    {
        return NumericValue;
    }

    inline const DSRCodedEntryValue &getMeasurementUnit() const
    {
        return MeasurementUnit;
    }

    inline const DSRCodedEntryValue &getNumericValueQualifier() const
    {
        return ValueQualifier;
    }

    OFCondition getMeasurementUnit(DSRCodedEntryValue &measurementUnit) const;

    OFCondition setValue(const DSRNumericMeasurementValue &numericMeasurement);

    OFCondition setValue(const OFString &numericValue,
                         const DSRCodedEntryValue &measurementUnit);

    OFCondition setValue(const OFString &numericValue,
                         const DSRCodedEntryValue &measurementUnit,
                         const DSRCodedEntryValue &valueQualifier);

    OFCondition setNumericValue(const OFString &numericValue);

    OFCondition setMeasurementUnit(const DSRCodedEntryValue &measurementUnit);

    OFCondition setNumericValueQualifier(const DSRCodedEntryValue &valueQualifier);

    OFBool valueContainsExtendedCharacters() const;


  protected:

    inline DSRNumericMeasurementValue *getValuePtr()
    {
        return this;
    }

    virtual OFCondition readItem(DcmItem &dataset,
                                 OFConsole *logStream);

    virtual OFCondition writeItem(DcmItem &dataset,
                                  OFConsole *logStream) const;

    virtual OFBool checkNumericValue(const OFString &numericValue) const;

    virtual OFBool checkMeasurementUnit(const DSRCodedEntryValue &measurementUnit) const;

    virtual OFBool checkNumericValueQualifier(const DSRCodedEntryValue &valueQualifier) const;


  private:

    OFString           NumericValue;
    DSRCodedEntryValue MeasurementUnit;
    DSRCodedEntryValue ValueQualifier;
};


#endif


/*
 *  CVS/RCS Log:
 *  $Log: dsrnumvl.h,v $
 *  Revision 1.10  2005/12/08 16:05:11  meichel
 *  Changed include path schema for all DCMTK header files
 *
 *  Revision 1.9  2004/11/22 16:39:09  meichel
 *  Added method that checks if the SR document contains non-ASCII characters
 *    in any of the strings affected by SpecificCharacterSet.
 *
 *  Revision 1.8  2003/08/07 12:43:44  joergr
 *  Added readXML functionality.
 *
 *  Revision 1.7  2002/12/10 13:20:07  joergr
 *  Added support for the Numeric Value Qualifier Code Sequence (introduced with
 *  CP 260).
 *
 *  Revision 1.6  2001/09/26 13:04:09  meichel
 *  Adapted dcmsr to class OFCondition
 *
 *  Revision 1.5  2001/06/01 15:51:02  meichel
 *  Updated copyright header
 *
 *  Revision 1.4  2000/11/06 11:17:40  joergr
 *  Moved some protected methods to public part.
 *
 *  Revision 1.3  2000/11/01 16:23:22  joergr
 *  Added support for conversion to XML.
 *
 *  Revision 1.2  2000/10/18 17:05:12  joergr
 *  Added methods allowing direct access to certain content item values.
 *  Added doc++ comments.
 *  Made some functions inline.
 *
 *  Revision 1.1  2000/10/13 07:49:29  joergr
 *  Added new module 'dcmsr' providing access to DICOM structured reporting
 *  documents (supplement 23).  Doc++ documentation not yet completed.
 *
 *
 */

---

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5