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

Item class. More...

+ Inheritance diagram for DRTDeliveredDepthDoseParametersSequence::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 getDeliveredDistalDepth (Float32 &value, const unsigned long pos=0) const
 get DeliveredDistalDepth (300a,0508) More...
 
OFCondition getDeliveredDistalDepthFraction (Float32 &value, const unsigned long pos=0) const
 get DeliveredDistalDepthFraction (300a,0507) More...
 
OFCondition getDeliveredNominalRangeModulatedRegionDepths (Float32 &value, const unsigned long pos=0) const
 get DeliveredNominalRangeModulatedRegionDepths (300a,0510) More...
 
OFCondition getDeliveredNominalRangeModulationFractions (Float32 &value, const unsigned long pos=0) const
 get DeliveredNominalRangeModulationFractions (300a,0509) More...
 
OFCondition getDeliveredReferenceDoseDefinition (OFString &value, const signed long pos=0) const
 get DeliveredReferenceDoseDefinition (300a,0511) More...
 
OFCondition setDeliveredDistalDepth (const Float32 value, const unsigned long pos=0)
 set DeliveredDistalDepth (300a,0508) More...
 
OFCondition setDeliveredDistalDepthFraction (const Float32 value, const unsigned long pos=0)
 set DeliveredDistalDepthFraction (300a,0507) More...
 
OFCondition setDeliveredNominalRangeModulatedRegionDepths (const Float32 value, const unsigned long pos=0)
 set DeliveredNominalRangeModulatedRegionDepths (300a,0510) More...
 
OFCondition setDeliveredNominalRangeModulationFractions (const Float32 value, const unsigned long pos=0)
 set DeliveredNominalRangeModulationFractions (300a,0509) More...
 
OFCondition setDeliveredReferenceDoseDefinition (const OFString &value, const OFBool check=OFTrue)
 set DeliveredReferenceDoseDefinition (300a,0511) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmFloatingPointSingle DeliveredDistalDepth
 DeliveredDistalDepth (300a,0508) vr=FL, vm=1, type=1.
 
DcmFloatingPointSingle DeliveredDistalDepthFraction
 DeliveredDistalDepthFraction (300a,0507) vr=FL, vm=1, type=1.
 
DcmFloatingPointSingle DeliveredNominalRangeModulatedRegionDepths
 DeliveredNominalRangeModulatedRegionDepths (300a,0510) vr=FL, vm=2, type=1C.
 
DcmFloatingPointSingle DeliveredNominalRangeModulationFractions
 DeliveredNominalRangeModulationFractions (300a,0509) vr=FL, vm=2, type=1C.
 
DcmCodeString DeliveredReferenceDoseDefinition
 DeliveredReferenceDoseDefinition (300a,0511) 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

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

(default) constructor

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

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

OFCondition DRTDeliveredDepthDoseParametersSequence::Item::getDeliveredDistalDepth ( Float32 &  value,
const unsigned long  pos = 0 
) const

get DeliveredDistalDepth (300a,0508)

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

get DeliveredDistalDepthFraction (300a,0507)

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

get DeliveredNominalRangeModulatedRegionDepths (300a,0510)

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

get DeliveredNominalRangeModulationFractions (300a,0509)

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

get DeliveredReferenceDoseDefinition (300a,0511)

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

check if item is empty

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

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

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

assigment operator

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

set DeliveredDistalDepth (300a,0508)

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

set DeliveredDistalDepthFraction (300a,0507)

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

set DeliveredNominalRangeModulatedRegionDepths (300a,0510)

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

set DeliveredNominalRangeModulationFractions (300a,0509)

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 DRTDeliveredDepthDoseParametersSequence::Item::setDeliveredReferenceDoseDefinition ( const OFString value,
const OFBool  check = OFTrue 
)

set DeliveredReferenceDoseDefinition (300a,0511)

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