DCMTK  Version 3.6.1 20150924
OFFIS DICOM Toolkit
Public Member Functions | Protected Member Functions | List of all members
CMR_SRNumericMeasurementValue Class Reference

Class for SR numeric measurement values (extended version with additional support of the DICOM Content Mapping Resource) More...

+ Inheritance diagram for CMR_SRNumericMeasurementValue:

Public Member Functions

 CMR_SRNumericMeasurementValue ()
 default constructor
 
 CMR_SRNumericMeasurementValue (const OFString &numericValue, const DSRCodedEntryValue &measurementUnit, const OFBool check=OFTrue)
 constructor More...
 
 CMR_SRNumericMeasurementValue (const OFString &numericValue, const DSRCodedEntryValue &measurementUnit, const DSRCodedEntryValue &valueQualifier, const OFBool check=OFTrue)
 constructor More...
 
 CMR_SRNumericMeasurementValue (const CMR_SRNumericMeasurementValue &numericMeasurement)
 copy constructor More...
 
virtual ~CMR_SRNumericMeasurementValue ()
 destructor
 
CMR_SRNumericMeasurementValueoperator= (const CMR_SRNumericMeasurementValue &numericMeasurement)
 assignment operator More...
 
OFCondition setNumericValueQualifier (CID42_NumericValueQualifier::EnumType valueQualifier, const OFBool enhancedEncodingMode=OFFalse)
 set numeric value qualifier. More...
 
- Public Member Functions inherited from DSRNumericMeasurementValue
 DSRNumericMeasurementValue ()
 default constructor
 
 DSRNumericMeasurementValue (const OFString &numericValue, const DSRCodedEntryValue &measurementUnit, const OFBool check=OFTrue)
 constructor More...
 
 DSRNumericMeasurementValue (const OFString &numericValue, const DSRCodedEntryValue &measurementUnit, const DSRCodedEntryValue &valueQualifier, const OFBool check=OFTrue)
 constructor More...
 
 DSRNumericMeasurementValue (const DSRNumericMeasurementValue &numericMeasurement)
 copy constructor More...
 
virtual ~DSRNumericMeasurementValue ()
 destructor
 
DSRNumericMeasurementValueoperator= (const DSRNumericMeasurementValue &numericMeasurement)
 assignment operator More...
 
virtual void clear ()
 clear all internal variables. More...
 
virtual OFBool isValid () const
 check whether the current numeric measurement value is valid. More...
 
virtual OFBool isEmpty () const
 check whether the current numeric measurement value is empty. More...
 
virtual OFCondition print (STD_NAMESPACE ostream &stream, const size_t flags) const
 print numeric measurement value. More...
 
virtual OFCondition readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags)
 read numeric measurement value from XML document More...
 
virtual OFCondition writeXML (STD_NAMESPACE ostream &stream, const size_t flags) const
 write numeric measurement value in XML format More...
 
virtual OFCondition readSequence (DcmItem &dataset, const size_t flags)
 read measured value sequence and numeric value qualifier code sequence from dataset. More...
 
virtual OFCondition writeSequence (DcmItem &dataset) const
 write measured value sequence and numeric value qualifier code sequence to dataset. More...
 
virtual OFCondition renderHTML (STD_NAMESPACE ostream &docStream, STD_NAMESPACE ostream &annexStream, size_t &annexNumber, const size_t flags) const
 render numeric measurement value in HTML/XHTML format More...
 
const DSRNumericMeasurementValuegetValue () const
 get reference to numeric measurement value More...
 
OFCondition getValue (DSRNumericMeasurementValue &numericMeasurement) const
 get copy of numeric measurement value More...
 
const OFStringgetNumericValue () const
 get numeric value More...
 
const DSRCodedEntryValuegetMeasurementUnit () const
 get measurement unit More...
 
const DSRCodedEntryValuegetNumericValueQualifier () const
 get numeric value qualifier (optional) More...
 
OFCondition getMeasurementUnit (DSRCodedEntryValue &measurementUnit) const
 get copy of measurement unit More...
 
OFCondition getNumericValueQualifier (DSRCodedEntryValue &valueQualifier) const
 get copy of numeric value qualifier (optional). More...
 
OFCondition getFloatingPointRepresentation (Float64 &floatingPoint) const
 get floating point representation of the numeric value (optional) More...
 
OFCondition getRationalRepresentation (Sint32 &rationalNumerator, Uint32 &rationalDenominator) const
 get rational representation of the numeric value (optional) More...
 
OFCondition setValue (const DSRNumericMeasurementValue &numericMeasurement, const OFBool check=OFTrue)
 set numeric measurement value. More...
 
OFCondition setValue (const OFString &numericValue, const DSRCodedEntryValue &measurementUnit, const OFBool check=OFTrue)
 set numeric value and measurement unit. More...
 
OFCondition setValue (const OFString &numericValue, const DSRCodedEntryValue &measurementUnit, const DSRCodedEntryValue &valueQualifier, const OFBool check=OFTrue)
 set numeric value, measurement unit and numeric value qualifier. More...
 
OFCondition setNumericValue (const OFString &numericValue, const OFBool check=OFTrue)
 set numeric value. More...
 
OFCondition setNumericValue (const DcmElement &delem, const unsigned long pos=0, const OFBool check=OFTrue)
 set numeric value from element. More...
 
OFCondition setNumericValue (DcmItem &dataset, const DcmTagKey &tagKey, const unsigned long pos=0, const OFBool check=OFTrue)
 set numeric value from dataset. More...
 
OFCondition setMeasurementUnit (const DSRCodedEntryValue &measurementUnit, const OFBool check=OFTrue)
 set measurement unit. More...
 
OFCondition setNumericValueQualifier (const DSRCodedEntryValue &valueQualifier, const OFBool check=OFTrue)
 set numeric value qualifier. More...
 
OFCondition setFloatingPointRepresentation (const Float64 floatingPoint, const OFBool check=OFTrue)
 set floating point representation of the numeric value. More...
 
OFCondition setRationalRepresentation (const Sint32 rationalNumerator, const Uint32 rationalDenominator, const OFBool check=OFTrue)
 set rational representation of the numeric value. More...
 
void removeFloatingPointRepresentation ()
 remove floating point representation of the numeric value (if any). More...
 
void removeRationalRepresentation ()
 remove rational representation of the numeric value (if any). More...
 

Protected Member Functions

virtual OFCondition checkNumericValueQualifier (const DSRCodedEntryValue &valueQualifier) const
 check the specified numeric value qualifier for validity. More...
 
- Protected Member Functions inherited from DSRNumericMeasurementValue
DSRNumericMeasurementValuegetValuePtr ()
 get pointer to numeric measurement value More...
 
virtual OFCondition readItem (DcmItem &dataset, const size_t flags)
 read numeric measurement value from dataset More...
 
virtual OFCondition writeItem (DcmItem &dataset) const
 write numeric measurement value to dataset More...
 
virtual OFCondition checkNumericValue (const OFString &numericValue) const
 check the specified numeric value for validity. More...
 
virtual OFCondition checkMeasurementUnit (const DSRCodedEntryValue &measurementUnit) const
 check the specified measurement unit for validity. More...
 
virtual OFCondition checkRationalRepresentation (const Sint32 rationalNumerator, const Uint32 rationalDenominator) const
 check the specified rational representation for validity. More...
 
virtual OFCondition checkCurrentValue () const
 check the currently stored numeric measurement value for validity. More...
 

Detailed Description

Class for SR numeric measurement values (extended version with additional support of the DICOM Content Mapping Resource)

Constructor & Destructor Documentation

CMR_SRNumericMeasurementValue::CMR_SRNumericMeasurementValue ( const OFString numericValue,
const DSRCodedEntryValue measurementUnit,
const OFBool  check = OFTrue 
)

constructor

Parameters
numericValuenumeric measurement value (VR=DS, mandatory)
measurementUnitcode representing the units of measurement (mandatory)
checkif enabled, check 'numericValue' and 'measurementUnit' for validity before setting them. See corresponding setValue() method for details.
CMR_SRNumericMeasurementValue::CMR_SRNumericMeasurementValue ( const OFString numericValue,
const DSRCodedEntryValue measurementUnit,
const DSRCodedEntryValue valueQualifier,
const OFBool  check = OFTrue 
)

constructor

Parameters
numericValuenumeric measurement value (VR=DS, mandatory)
measurementUnitcode representing the units of measurement (mandatory)
valueQualifiercode representing the numeric value qualifier (optional). Can also be used to specify the reason for the absence of the measured value sequence.
checkif enabled, check values for validity before setting them. See corresponding setValue() method for details.
CMR_SRNumericMeasurementValue::CMR_SRNumericMeasurementValue ( const CMR_SRNumericMeasurementValue numericMeasurement)

copy constructor

Parameters
numericMeasurementnumeric measurement value to be copied (not checked !)

Member Function Documentation

virtual OFCondition CMR_SRNumericMeasurementValue::checkNumericValueQualifier ( const DSRCodedEntryValue valueQualifier) const
protectedvirtual

check the specified numeric value qualifier for validity.

In addition to DSRNumericMeasurementValue::checkNumericValueQualifier(), this method also checks the conformance with the Context Group 42 (see CID42_NumericValueQualifier).

Parameters
valueQualifiernumeric value qualifier to be checked
Returns
status, EC_Normal if value qualifier is valid, an error code otherwise

Reimplemented from DSRNumericMeasurementValue.

CMR_SRNumericMeasurementValue& CMR_SRNumericMeasurementValue::operator= ( const CMR_SRNumericMeasurementValue numericMeasurement)

assignment operator

Parameters
numericMeasurementnumeric measurement value to be copied (not checked !)
Returns
reference to this numeric value after 'numericMeasurement' has been copied
OFCondition CMR_SRNumericMeasurementValue::setNumericValueQualifier ( CID42_NumericValueQualifier::EnumType  valueQualifier,
const OFBool  enhancedEncodingMode = OFFalse 
)

set numeric value qualifier.

This optional code specifies the qualification of the Numeric Value in the Measured Value Sequence, or the reason for the absence of the Measured Value Sequence Item.

Parameters
valueQualifiernumeric value qualifier to be set
enhancedEncodingModeset enhanced encoding mode for coded entry (if enabled)
Returns
status, EC_Normal if successful, an error code otherwise

The documentation for this class was generated from the following file:


Generated on Tue Jan 5 2016 for DCMTK Version 3.6.1 20150924 by Doxygen 1.8.9.1