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

Item class. More...

+ Inheritance diagram for DRTRangeModulatorSettingsSequenceInRTIonBeamsModule::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 getIsocenterToRangeModulatorDistance (Float32 &value, const unsigned long pos=0) const
 get IsocenterToRangeModulatorDistance (300a,038a) More...
 
OFCondition getRangeModulatorGatingStartValue (Float32 &value, const unsigned long pos=0) const
 get RangeModulatorGatingStartValue (300a,0382) More...
 
OFCondition getRangeModulatorGatingStartWaterEquivalentThickness (Float32 &value, const unsigned long pos=0) const
 get RangeModulatorGatingStartWaterEquivalentThickness (300a,0386) More...
 
OFCondition getRangeModulatorGatingStopValue (Float32 &value, const unsigned long pos=0) const
 get RangeModulatorGatingStopValue (300a,0384) More...
 
OFCondition getRangeModulatorGatingStopWaterEquivalentThickness (Float32 &value, const unsigned long pos=0) const
 get RangeModulatorGatingStopWaterEquivalentThickness (300a,0388) More...
 
OFCondition getReferencedRangeModulatorNumber (OFString &value, const signed long pos=0) const
 get ReferencedRangeModulatorNumber (300c,0104) More...
 
OFCondition getReferencedRangeModulatorNumber (Sint32 &value, const unsigned long pos=0) const
 get ReferencedRangeModulatorNumber (300c,0104) More...
 
OFCondition setIsocenterToRangeModulatorDistance (const Float32 value, const unsigned long pos=0)
 set IsocenterToRangeModulatorDistance (300a,038a) More...
 
OFCondition setRangeModulatorGatingStartValue (const Float32 value, const unsigned long pos=0)
 set RangeModulatorGatingStartValue (300a,0382) More...
 
OFCondition setRangeModulatorGatingStartWaterEquivalentThickness (const Float32 value, const unsigned long pos=0)
 set RangeModulatorGatingStartWaterEquivalentThickness (300a,0386) More...
 
OFCondition setRangeModulatorGatingStopValue (const Float32 value, const unsigned long pos=0)
 set RangeModulatorGatingStopValue (300a,0384) More...
 
OFCondition setRangeModulatorGatingStopWaterEquivalentThickness (const Float32 value, const unsigned long pos=0)
 set RangeModulatorGatingStopWaterEquivalentThickness (300a,0388) More...
 
OFCondition setReferencedRangeModulatorNumber (const OFString &value, const OFBool check=OFTrue)
 set ReferencedRangeModulatorNumber (300c,0104) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmFloatingPointSingle IsocenterToRangeModulatorDistance
 IsocenterToRangeModulatorDistance (300a,038a) vr=FL, vm=1, type=3.
 
DcmFloatingPointSingle RangeModulatorGatingStartValue
 RangeModulatorGatingStartValue (300a,0382) vr=FL, vm=1, type=1C.
 
DcmFloatingPointSingle RangeModulatorGatingStartWaterEquivalentThickness
 RangeModulatorGatingStartWaterEquivalentThickness (300a,0386) vr=FL, vm=1, type=3.
 
DcmFloatingPointSingle RangeModulatorGatingStopValue
 RangeModulatorGatingStopValue (300a,0384) vr=FL, vm=1, type=1C.
 
DcmFloatingPointSingle RangeModulatorGatingStopWaterEquivalentThickness
 RangeModulatorGatingStopWaterEquivalentThickness (300a,0388) vr=FL, vm=1, type=3.
 
DcmIntegerString ReferencedRangeModulatorNumber
 ReferencedRangeModulatorNumber (300c,0104) vr=IS, 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

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

(default) constructor

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

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

OFCondition DRTRangeModulatorSettingsSequenceInRTIonBeamsModule::Item::getIsocenterToRangeModulatorDistance ( Float32 &  value,
const unsigned long  pos = 0 
) const

get IsocenterToRangeModulatorDistance (300a,038a)

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

get RangeModulatorGatingStartValue (300a,0382)

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

get RangeModulatorGatingStartWaterEquivalentThickness (300a,0386)

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

get RangeModulatorGatingStopValue (300a,0384)

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

get RangeModulatorGatingStopWaterEquivalentThickness (300a,0388)

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

get ReferencedRangeModulatorNumber (300c,0104)

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

get ReferencedRangeModulatorNumber (300c,0104)

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

check if item is empty

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

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

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

assigment operator

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

set IsocenterToRangeModulatorDistance (300a,038a)

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

set RangeModulatorGatingStartValue (300a,0382)

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

set RangeModulatorGatingStartWaterEquivalentThickness (300a,0386)

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

set RangeModulatorGatingStopValue (300a,0384)

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

set RangeModulatorGatingStopWaterEquivalentThickness (300a,0388)

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

set ReferencedRangeModulatorNumber (300c,0104)

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