DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Attributes | List of all members
DRTMeasuredDoseReferenceSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTMeasuredDoseReferenceSequence::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 getDoseUnits (OFString &value, const signed long pos=0) const
 get DoseUnits (3004,0002) More...
 
OFCondition getMeasuredDoseDescription (OFString &value, const signed long pos=0) const
 get MeasuredDoseDescription (3008,0012) More...
 
OFCondition getMeasuredDoseReferenceNumber (OFString &value, const signed long pos=0) const
 get MeasuredDoseReferenceNumber (3008,0064) More...
 
OFCondition getMeasuredDoseReferenceNumber (Sint32 &value, const unsigned long pos=0) const
 get MeasuredDoseReferenceNumber (3008,0064) More...
 
OFCondition getMeasuredDoseType (OFString &value, const signed long pos=0) const
 get MeasuredDoseType (3008,0014) More...
 
OFCondition getMeasuredDoseValue (OFString &value, const signed long pos=0) const
 get MeasuredDoseValue (3008,0016) More...
 
OFCondition getMeasuredDoseValue (Float64 &value, const unsigned long pos=0) const
 get MeasuredDoseValue (3008,0016) More...
 
OFCondition getReferencedDoseReferenceNumber (OFString &value, const signed long pos=0) const
 get ReferencedDoseReferenceNumber (300c,0051) More...
 
OFCondition getReferencedDoseReferenceNumber (Sint32 &value, const unsigned long pos=0) const
 get ReferencedDoseReferenceNumber (300c,0051) More...
 
OFCondition setDoseUnits (const OFString &value, const OFBool check=OFTrue)
 set DoseUnits (3004,0002) More...
 
OFCondition setMeasuredDoseDescription (const OFString &value, const OFBool check=OFTrue)
 set MeasuredDoseDescription (3008,0012) More...
 
OFCondition setMeasuredDoseReferenceNumber (const OFString &value, const OFBool check=OFTrue)
 set MeasuredDoseReferenceNumber (3008,0064) More...
 
OFCondition setMeasuredDoseType (const OFString &value, const OFBool check=OFTrue)
 set MeasuredDoseType (3008,0014) More...
 
OFCondition setMeasuredDoseValue (const OFString &value, const OFBool check=OFTrue)
 set MeasuredDoseValue (3008,0016) More...
 
OFCondition setReferencedDoseReferenceNumber (const OFString &value, const OFBool check=OFTrue)
 set ReferencedDoseReferenceNumber (300c,0051) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmCodeString DoseUnits
 DoseUnits (3004,0002) vr=CS, vm=1, type=1.
 
DcmShortText MeasuredDoseDescription
 MeasuredDoseDescription (3008,0012) vr=ST, vm=1, type=3.
 
DcmIntegerString MeasuredDoseReferenceNumber
 MeasuredDoseReferenceNumber (3008,0064) vr=IS, vm=1, type=1C.
 
DcmCodeString MeasuredDoseType
 MeasuredDoseType (3008,0014) vr=CS, vm=1, type=2.
 
DcmDecimalString MeasuredDoseValue
 MeasuredDoseValue (3008,0016) vr=DS, vm=1, type=2.
 
DcmIntegerString ReferencedDoseReferenceNumber
 ReferencedDoseReferenceNumber (300c,0051) vr=IS, 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

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item
DRTMeasuredDoseReferenceSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

OFCondition DRTMeasuredDoseReferenceSequence::Item::getDoseUnits ( OFString value,
const signed long  pos = 0 
) const

get DoseUnits (3004,0002)

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
OFCondition DRTMeasuredDoseReferenceSequence::Item::getMeasuredDoseDescription ( OFString value,
const signed long  pos = 0 
) const

get MeasuredDoseDescription (3008,0012)

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
OFCondition DRTMeasuredDoseReferenceSequence::Item::getMeasuredDoseReferenceNumber ( OFString value,
const signed long  pos = 0 
) const

get MeasuredDoseReferenceNumber (3008,0064)

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
OFCondition DRTMeasuredDoseReferenceSequence::Item::getMeasuredDoseReferenceNumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get MeasuredDoseReferenceNumber (3008,0064)

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
OFCondition DRTMeasuredDoseReferenceSequence::Item::getMeasuredDoseType ( OFString value,
const signed long  pos = 0 
) const

get MeasuredDoseType (3008,0014)

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
OFCondition DRTMeasuredDoseReferenceSequence::Item::getMeasuredDoseValue ( OFString value,
const signed long  pos = 0 
) const

get MeasuredDoseValue (3008,0016)

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
OFCondition DRTMeasuredDoseReferenceSequence::Item::getMeasuredDoseValue ( Float64 &  value,
const unsigned long  pos = 0 
) const

get MeasuredDoseValue (3008,0016)

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
OFCondition DRTMeasuredDoseReferenceSequence::Item::getReferencedDoseReferenceNumber ( OFString value,
const signed long  pos = 0 
) const

get ReferencedDoseReferenceNumber (300c,0051)

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
OFCondition DRTMeasuredDoseReferenceSequence::Item::getReferencedDoseReferenceNumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get ReferencedDoseReferenceNumber (300c,0051)

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
OFBool DRTMeasuredDoseReferenceSequence::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise
OFBool DRTMeasuredDoseReferenceSequence::Item::isValid ( ) const

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

Returns
OFTrue if item is valid, OFFalse otherwise
Item& DRTMeasuredDoseReferenceSequence::Item::operator= ( const Item copy)

assigment operator

Parameters
copyitem object to be copied
Returns
reference to this object
OFCondition DRTMeasuredDoseReferenceSequence::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
OFCondition DRTMeasuredDoseReferenceSequence::Item::setDoseUnits ( const OFString value,
const OFBool  check = OFTrue 
)

set DoseUnits (3004,0002)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTMeasuredDoseReferenceSequence::Item::setMeasuredDoseDescription ( const OFString value,
const OFBool  check = OFTrue 
)

set MeasuredDoseDescription (3008,0012)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (ST) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTMeasuredDoseReferenceSequence::Item::setMeasuredDoseReferenceNumber ( const OFString value,
const OFBool  check = OFTrue 
)

set MeasuredDoseReferenceNumber (3008,0064)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (IS) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTMeasuredDoseReferenceSequence::Item::setMeasuredDoseType ( const OFString value,
const OFBool  check = OFTrue 
)

set MeasuredDoseType (3008,0014)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTMeasuredDoseReferenceSequence::Item::setMeasuredDoseValue ( const OFString value,
const OFBool  check = OFTrue 
)

set MeasuredDoseValue (3008,0016)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (DS) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTMeasuredDoseReferenceSequence::Item::setReferencedDoseReferenceNumber ( const OFString value,
const OFBool  check = OFTrue 
)

set ReferencedDoseReferenceNumber (300c,0051)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (IS) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTMeasuredDoseReferenceSequence::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 Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8