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
DRTDepthDoseParametersSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTDepthDoseParametersSequence::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 getDistalDepth (Float32 &value, const unsigned long pos=0) const
 get DistalDepth (300a,0502) More...
 
OFCondition getDistalDepthFraction (Float32 &value, const unsigned long pos=0) const
 get DistalDepthFraction (300a,0501) More...
 
OFCondition getNominalRangeModulatedRegionDepths (Float32 &value, const unsigned long pos=0) const
 get NominalRangeModulatedRegionDepths (300a,0504) More...
 
OFCondition getNominalRangeModulationFractions (Float32 &value, const unsigned long pos=0) const
 get NominalRangeModulationFractions (300a,0503) More...
 
OFCondition getReferenceDoseDefinition (OFString &value, const signed long pos=0) const
 get ReferenceDoseDefinition (300a,0512) More...
 
OFCondition setDistalDepth (const Float32 value, const unsigned long pos=0)
 set DistalDepth (300a,0502) More...
 
OFCondition setDistalDepthFraction (const Float32 value, const unsigned long pos=0)
 set DistalDepthFraction (300a,0501) More...
 
OFCondition setNominalRangeModulatedRegionDepths (const Float32 value, const unsigned long pos=0)
 set NominalRangeModulatedRegionDepths (300a,0504) More...
 
OFCondition setNominalRangeModulationFractions (const Float32 value, const unsigned long pos=0)
 set NominalRangeModulationFractions (300a,0503) More...
 
OFCondition setReferenceDoseDefinition (const OFString &value, const OFBool check=OFTrue)
 set ReferenceDoseDefinition (300a,0512) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmFloatingPointSingle DistalDepth
 DistalDepth (300a,0502) vr=FL, vm=1, type=1.
 
DcmFloatingPointSingle DistalDepthFraction
 DistalDepthFraction (300a,0501) vr=FL, vm=1, type=1.
 
DcmFloatingPointSingle NominalRangeModulatedRegionDepths
 NominalRangeModulatedRegionDepths (300a,0504) vr=FL, vm=2, type=1C.
 
DcmFloatingPointSingle NominalRangeModulationFractions
 NominalRangeModulationFractions (300a,0503) vr=FL, vm=2, type=1C.
 
DcmCodeString ReferenceDoseDefinition
 ReferenceDoseDefinition (300a,0512) vr=CS, vm=1, type=1.
 

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

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

(default) constructor

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

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

OFCondition DRTDepthDoseParametersSequence::Item::getDistalDepth ( Float32 &  value,
const unsigned long  pos = 0 
) const

get DistalDepth (300a,0502)

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 DRTDepthDoseParametersSequence::Item::getDistalDepthFraction ( Float32 &  value,
const unsigned long  pos = 0 
) const

get DistalDepthFraction (300a,0501)

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 DRTDepthDoseParametersSequence::Item::getNominalRangeModulatedRegionDepths ( Float32 &  value,
const unsigned long  pos = 0 
) const

get NominalRangeModulatedRegionDepths (300a,0504)

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 DRTDepthDoseParametersSequence::Item::getNominalRangeModulationFractions ( Float32 &  value,
const unsigned long  pos = 0 
) const

get NominalRangeModulationFractions (300a,0503)

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

get ReferenceDoseDefinition (300a,0512)

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

check if item is empty

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

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

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

assigment operator

Parameters
copyitem object to be copied
Returns
reference to this object
OFCondition DRTDepthDoseParametersSequence::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 DRTDepthDoseParametersSequence::Item::setDistalDepth ( const Float32  value,
const unsigned long  pos = 0 
)

set DistalDepth (300a,0502)

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
OFCondition DRTDepthDoseParametersSequence::Item::setDistalDepthFraction ( const Float32  value,
const unsigned long  pos = 0 
)

set DistalDepthFraction (300a,0501)

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
OFCondition DRTDepthDoseParametersSequence::Item::setNominalRangeModulatedRegionDepths ( const Float32  value,
const unsigned long  pos = 0 
)

set NominalRangeModulatedRegionDepths (300a,0504)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=2
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDepthDoseParametersSequence::Item::setNominalRangeModulationFractions ( const Float32  value,
const unsigned long  pos = 0 
)

set NominalRangeModulationFractions (300a,0503)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=2
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDepthDoseParametersSequence::Item::setReferenceDoseDefinition ( const OFString value,
const OFBool  check = OFTrue 
)

set ReferenceDoseDefinition (300a,0512)

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 DRTDepthDoseParametersSequence::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