DCMTK  Version 3.6.4
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes | List of all members
DRTRealWorldValueMappingSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTRealWorldValueMappingSequence::Item:

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor More...
 
 Item (const Item &copy)
 copy constructor More...
 
virtual ~Item ()
 destructor
 
Itemoperator= (const Item &copy)
 assigment operator More...
 
void clear ()
 clear all internal member variables
 
OFBool isEmpty ()
 check if item is empty More...
 
OFBool isValid () const
 check if item is valid, i.e. not the empty default item More...
 
OFCondition read (DcmItem &item)
 read elements from sequence item More...
 
OFCondition write (DcmItem &item)
 write elements to sequence item More...
 
OFCondition getDoubleFloatRealWorldValueFirstValueMapped (Float64 &value, const unsigned long pos=0) const
 get DoubleFloatRealWorldValueFirstValueMapped (0040,9214) More...
 
OFCondition getDoubleFloatRealWorldValueLastValueMapped (Float64 &value, const unsigned long pos=0) const
 get DoubleFloatRealWorldValueLastValueMapped (0040,9213) More...
 
OFCondition getLUTExplanation (OFString &value, const signed long pos=0) const
 get LUTExplanation (0028,3003) More...
 
OFCondition getLUTLabel (OFString &value, const signed long pos=0) const
 get LUTLabel (0040,9210) More...
 
OFCondition getRealWorldValueFirstValueMapped (Uint16 &value, const unsigned long pos=0) const
 get RealWorldValueFirstValueMapped (0040,9216) More...
 
OFCondition getRealWorldValueIntercept (Float64 &value, const unsigned long pos=0) const
 get RealWorldValueIntercept (0040,9224) More...
 
OFCondition getRealWorldValueLUTData (Float64 &value, const unsigned long pos=0) const
 get RealWorldValueLUTData (0040,9212) More...
 
OFCondition getRealWorldValueLastValueMapped (Uint16 &value, const unsigned long pos=0) const
 get RealWorldValueLastValueMapped (0040,9211) More...
 
OFCondition getRealWorldValueSlope (Float64 &value, const unsigned long pos=0) const
 get RealWorldValueSlope (0040,9225) More...
 
DRTMeasurementUnitsCodeSequencegetMeasurementUnitsCodeSequence ()
 get MeasurementUnitsCodeSequence (0040,08ea) More...
 
const DRTMeasurementUnitsCodeSequencegetMeasurementUnitsCodeSequence () const
 get MeasurementUnitsCodeSequence (0040,08ea) More...
 
DRTQuantityDefinitionSequencegetQuantityDefinitionSequence ()
 get QuantityDefinitionSequence (0040,9220) More...
 
const DRTQuantityDefinitionSequencegetQuantityDefinitionSequence () const
 get QuantityDefinitionSequence (0040,9220) More...
 
OFCondition setDoubleFloatRealWorldValueFirstValueMapped (const Float64 value, const unsigned long pos=0)
 set DoubleFloatRealWorldValueFirstValueMapped (0040,9214) More...
 
OFCondition setDoubleFloatRealWorldValueLastValueMapped (const Float64 value, const unsigned long pos=0)
 set DoubleFloatRealWorldValueLastValueMapped (0040,9213) More...
 
OFCondition setLUTExplanation (const OFString &value, const OFBool check=OFTrue)
 set LUTExplanation (0028,3003) More...
 
OFCondition setLUTLabel (const OFString &value, const OFBool check=OFTrue)
 set LUTLabel (0040,9210) More...
 
OFCondition setRealWorldValueFirstValueMapped (const Uint16 value, const unsigned long pos=0)
 set RealWorldValueFirstValueMapped (0040,9216) More...
 
OFCondition setRealWorldValueIntercept (const Float64 value, const unsigned long pos=0)
 set RealWorldValueIntercept (0040,9224) More...
 
OFCondition setRealWorldValueLUTData (const Float64 value, const unsigned long pos=0)
 set RealWorldValueLUTData (0040,9212) More...
 
OFCondition setRealWorldValueLastValueMapped (const Uint16 value, const unsigned long pos=0)
 set RealWorldValueLastValueMapped (0040,9211) More...
 
OFCondition setRealWorldValueSlope (const Float64 value, const unsigned long pos=0)
 set RealWorldValueSlope (0040,9225) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmFloatingPointDouble DoubleFloatRealWorldValueFirstValueMapped
 DoubleFloatRealWorldValueFirstValueMapped (0040,9214) vr=FD, vm=1, type=1C.
 
DcmFloatingPointDouble DoubleFloatRealWorldValueLastValueMapped
 DoubleFloatRealWorldValueLastValueMapped (0040,9213) vr=FD, vm=1, type=1C.
 
DcmLongString LUTExplanation
 LUTExplanation (0028,3003) vr=LO, vm=1, type=1.
 
DcmShortString LUTLabel
 LUTLabel (0040,9210) vr=SH, vm=1, type=1.
 
DRTMeasurementUnitsCodeSequence MeasurementUnitsCodeSequence
 MeasurementUnitsCodeSequence (0040,08ea) vr=SQ, vm=1, type=1.
 
DRTQuantityDefinitionSequence QuantityDefinitionSequence
 QuantityDefinitionSequence (0040,9220) vr=SQ, vm=1, type=3.
 
DcmUnsignedShort RealWorldValueFirstValueMapped
 RealWorldValueFirstValueMapped (0040,9216) vr=US/SS, vm=1, type=1C.
 
DcmFloatingPointDouble RealWorldValueIntercept
 RealWorldValueIntercept (0040,9224) vr=FD, vm=1, type=1C.
 
DcmFloatingPointDouble RealWorldValueLUTData
 RealWorldValueLUTData (0040,9212) vr=FD, vm=1-n, type=1C.
 
DcmUnsignedShort RealWorldValueLastValueMapped
 RealWorldValueLastValueMapped (0040,9211) vr=US/SS, vm=1, type=1C.
 
DcmFloatingPointDouble RealWorldValueSlope
 RealWorldValueSlope (0040,9225) vr=FD, vm=1, type=1C.
 

Additional Inherited Members

- Protected Member Functions inherited from DRTTypes
virtual ~DRTTypes ()
 destructor. More...
 
- Static Protected Member Functions inherited from DRTTypes
static OFCondition addElementToDataset (OFCondition &result, DcmItem &dataset, DcmElement *element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 add given element to the dataset. More...
 
static OFCondition getElementFromDataset (DcmItem &dataset, DcmElement &element)
 get element from dataset More...
 
static OFCondition getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0)
 get string value from element More...
 
static OFCondition getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue)
 get string value from dataset More...
 
static OFCondition putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue)
 put string value to dataset More...
 
static OFBool checkElementValue (DcmElement &element, const OFString &vm, const OFString &type, const OFCondition &searchCond=EC_Normal, const char *moduleName=NULL)
 check element value for correct value multiplicity and type More...
 
static OFCondition getAndCheckElementFromDataset (DcmItem &dataset, DcmElement &element, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 get element from dataset and check it for correct value multiplicity and type. More...
 
static OFCondition getAndCheckStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue, const OFString &vm, const OFString &type, const char *moduleName=NULL)
 get string value from dataset and check it for correct value multiplicity and type. More...
 

Detailed Description

Item class.

Constructor & Destructor Documentation

◆ Item() [1/2]

DRTRealWorldValueMappingSequence::Item::Item ( const OFBool  emptyDefaultItem = OFFalse)

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item

◆ Item() [2/2]

DRTRealWorldValueMappingSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

◆ getDoubleFloatRealWorldValueFirstValueMapped()

OFCondition DRTRealWorldValueMappingSequence::Item::getDoubleFloatRealWorldValueFirstValueMapped ( Float64 &  value,
const unsigned long  pos = 0 
) const

get DoubleFloatRealWorldValueFirstValueMapped (0040,9214)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns
status, EC_Normal if successful, an error code otherwise

◆ getDoubleFloatRealWorldValueLastValueMapped()

OFCondition DRTRealWorldValueMappingSequence::Item::getDoubleFloatRealWorldValueLastValueMapped ( Float64 &  value,
const unsigned long  pos = 0 
) const

get DoubleFloatRealWorldValueLastValueMapped (0040,9213)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns
status, EC_Normal if successful, an error code otherwise

◆ getLUTExplanation()

OFCondition DRTRealWorldValueMappingSequence::Item::getLUTExplanation ( OFString value,
const signed long  pos = 0 
) const

get LUTExplanation (0028,3003)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns
status, EC_Normal if successful, an error code otherwise

◆ getLUTLabel()

OFCondition DRTRealWorldValueMappingSequence::Item::getLUTLabel ( OFString value,
const signed long  pos = 0 
) const

get LUTLabel (0040,9210)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns
status, EC_Normal if successful, an error code otherwise

◆ getMeasurementUnitsCodeSequence() [1/2]

DRTMeasurementUnitsCodeSequence& DRTRealWorldValueMappingSequence::Item::getMeasurementUnitsCodeSequence ( )
inline

get MeasurementUnitsCodeSequence (0040,08ea)

Returns
reference to sequence element

◆ getMeasurementUnitsCodeSequence() [2/2]

const DRTMeasurementUnitsCodeSequence& DRTRealWorldValueMappingSequence::Item::getMeasurementUnitsCodeSequence ( ) const
inline

get MeasurementUnitsCodeSequence (0040,08ea)

Returns
const reference to sequence element

◆ getQuantityDefinitionSequence() [1/2]

DRTQuantityDefinitionSequence& DRTRealWorldValueMappingSequence::Item::getQuantityDefinitionSequence ( )
inline

get QuantityDefinitionSequence (0040,9220)

Returns
reference to sequence element

◆ getQuantityDefinitionSequence() [2/2]

const DRTQuantityDefinitionSequence& DRTRealWorldValueMappingSequence::Item::getQuantityDefinitionSequence ( ) const
inline

get QuantityDefinitionSequence (0040,9220)

Returns
const reference to sequence element

◆ getRealWorldValueFirstValueMapped()

OFCondition DRTRealWorldValueMappingSequence::Item::getRealWorldValueFirstValueMapped ( Uint16 &  value,
const unsigned long  pos = 0 
) const

get RealWorldValueFirstValueMapped (0040,9216)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns
status, EC_Normal if successful, an error code otherwise

◆ getRealWorldValueIntercept()

OFCondition DRTRealWorldValueMappingSequence::Item::getRealWorldValueIntercept ( Float64 &  value,
const unsigned long  pos = 0 
) const

get RealWorldValueIntercept (0040,9224)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns
status, EC_Normal if successful, an error code otherwise

◆ getRealWorldValueLastValueMapped()

OFCondition DRTRealWorldValueMappingSequence::Item::getRealWorldValueLastValueMapped ( Uint16 &  value,
const unsigned long  pos = 0 
) const

get RealWorldValueLastValueMapped (0040,9211)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns
status, EC_Normal if successful, an error code otherwise

◆ getRealWorldValueLUTData()

OFCondition DRTRealWorldValueMappingSequence::Item::getRealWorldValueLUTData ( Float64 &  value,
const unsigned long  pos = 0 
) const

get RealWorldValueLUTData (0040,9212)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns
status, EC_Normal if successful, an error code otherwise

◆ getRealWorldValueSlope()

OFCondition DRTRealWorldValueMappingSequence::Item::getRealWorldValueSlope ( Float64 &  value,
const unsigned long  pos = 0 
) const

get RealWorldValueSlope (0040,9225)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns
status, EC_Normal if successful, an error code otherwise

◆ isEmpty()

OFBool DRTRealWorldValueMappingSequence::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTRealWorldValueMappingSequence::Item::isValid ( ) const

check if item is valid, i.e. not the empty default item

Returns
OFTrue if item is valid, OFFalse otherwise

◆ operator=()

Item& DRTRealWorldValueMappingSequence::Item::operator= ( const Item copy)

assigment operator

Parameters
copyitem object to be copied
Returns
reference to this object

◆ read()

OFCondition DRTRealWorldValueMappingSequence::Item::read ( DcmItem item)

read elements from sequence item

Parameters
itemreference to DICOM sequence item from which the elements should be read
Returns
status, EC_Normal if successful, an error code otherwise

◆ setDoubleFloatRealWorldValueFirstValueMapped()

OFCondition DRTRealWorldValueMappingSequence::Item::setDoubleFloatRealWorldValueFirstValueMapped ( const Float64  value,
const unsigned long  pos = 0 
)

set DoubleFloatRealWorldValueFirstValueMapped (0040,9214)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns
status, EC_Normal if successful, an error code otherwise

◆ setDoubleFloatRealWorldValueLastValueMapped()

OFCondition DRTRealWorldValueMappingSequence::Item::setDoubleFloatRealWorldValueLastValueMapped ( const Float64  value,
const unsigned long  pos = 0 
)

set DoubleFloatRealWorldValueLastValueMapped (0040,9213)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns
status, EC_Normal if successful, an error code otherwise

◆ setLUTExplanation()

OFCondition DRTRealWorldValueMappingSequence::Item::setLUTExplanation ( const OFString value,
const OFBool  check = OFTrue 
)

set LUTExplanation (0028,3003)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (LO) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise

◆ setLUTLabel()

OFCondition DRTRealWorldValueMappingSequence::Item::setLUTLabel ( const OFString value,
const OFBool  check = OFTrue 
)

set LUTLabel (0040,9210)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (SH) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise

◆ setRealWorldValueFirstValueMapped()

OFCondition DRTRealWorldValueMappingSequence::Item::setRealWorldValueFirstValueMapped ( const Uint16  value,
const unsigned long  pos = 0 
)

set RealWorldValueFirstValueMapped (0040,9216)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns
status, EC_Normal if successful, an error code otherwise

◆ setRealWorldValueIntercept()

OFCondition DRTRealWorldValueMappingSequence::Item::setRealWorldValueIntercept ( const Float64  value,
const unsigned long  pos = 0 
)

set RealWorldValueIntercept (0040,9224)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns
status, EC_Normal if successful, an error code otherwise

◆ setRealWorldValueLastValueMapped()

OFCondition DRTRealWorldValueMappingSequence::Item::setRealWorldValueLastValueMapped ( const Uint16  value,
const unsigned long  pos = 0 
)

set RealWorldValueLastValueMapped (0040,9211)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns
status, EC_Normal if successful, an error code otherwise

◆ setRealWorldValueLUTData()

OFCondition DRTRealWorldValueMappingSequence::Item::setRealWorldValueLUTData ( const Float64  value,
const unsigned long  pos = 0 
)

set RealWorldValueLUTData (0040,9212)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1-n
Returns
status, EC_Normal if successful, an error code otherwise

◆ setRealWorldValueSlope()

OFCondition DRTRealWorldValueMappingSequence::Item::setRealWorldValueSlope ( const Float64  value,
const unsigned long  pos = 0 
)

set RealWorldValueSlope (0040,9225)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns
status, EC_Normal if successful, an error code otherwise

◆ write()

OFCondition DRTRealWorldValueMappingSequence::Item::write ( DcmItem item)

write elements to sequence item

Parameters
itemreference to DICOM sequence item to which the elements should be written
Returns
status, EC_Normal if successful, an error code otherwise

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


Generated on Thu Nov 29 2018 for DCMTK Version 3.6.4 by Doxygen 1.8.14