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

Item class. More...

+ Inheritance diagram for DRTEnhancedRTBeamLimitingOpeningSequence::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)
 assignment 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 getParallelRTBeamDelimiterPositions (Float64 &value, const unsigned long pos=0) const
 get ParallelRTBeamDelimiterPositions (300a,064a) More...
 
OFCondition getRTBeamLimitingDeviceOffset (Float64 &value, const unsigned long pos=0) const
 get RTBeamLimitingDeviceOffset (300a,064b) More...
 
OFCondition getReferencedDeviceIndex (Uint16 &value, const unsigned long pos=0) const
 get ReferencedDeviceIndex (300a,0607) More...
 
DRTRTBeamDelimiterGeometrySequencegetRTBeamDelimiterGeometrySequence ()
 get RTBeamDelimiterGeometrySequence (300a,064c) More...
 
const DRTRTBeamDelimiterGeometrySequencegetRTBeamDelimiterGeometrySequence () const
 get RTBeamDelimiterGeometrySequence (300a,064c) More...
 
OFCondition setParallelRTBeamDelimiterPositions (const Float64 value, const unsigned long pos=0)
 set ParallelRTBeamDelimiterPositions (300a,064a) More...
 
OFCondition setRTBeamLimitingDeviceOffset (const Float64 value, const unsigned long pos=0)
 set RTBeamLimitingDeviceOffset (300a,064b) More...
 
OFCondition setReferencedDeviceIndex (const Uint16 value, const unsigned long pos=0)
 set ReferencedDeviceIndex (300a,0607) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmFloatingPointDouble ParallelRTBeamDelimiterPositions
 ParallelRTBeamDelimiterPositions (300a,064a) vr=FD, vm=2-n, type=1C.
 
DRTRTBeamDelimiterGeometrySequence RTBeamDelimiterGeometrySequence
 RTBeamDelimiterGeometrySequence (300a,064c) vr=SQ, vm=1, type=1C.
 
DcmFloatingPointDouble RTBeamLimitingDeviceOffset
 RTBeamLimitingDeviceOffset (300a,064b) vr=FD, vm=2, type=1C.
 
DcmUnsignedShort ReferencedDeviceIndex
 ReferencedDeviceIndex (300a,0607) vr=US, 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

◆ Item() [1/2]

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item

◆ Item() [2/2]

DRTEnhancedRTBeamLimitingOpeningSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

◆ getParallelRTBeamDelimiterPositions()

OFCondition DRTEnhancedRTBeamLimitingOpeningSequence::Item::getParallelRTBeamDelimiterPositions ( Float64 &  value,
const unsigned long  pos = 0 
) const

get ParallelRTBeamDelimiterPositions (300a,064a)

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

◆ getReferencedDeviceIndex()

OFCondition DRTEnhancedRTBeamLimitingOpeningSequence::Item::getReferencedDeviceIndex ( Uint16 &  value,
const unsigned long  pos = 0 
) const

get ReferencedDeviceIndex (300a,0607)

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

◆ getRTBeamDelimiterGeometrySequence() [1/2]

DRTRTBeamDelimiterGeometrySequence & DRTEnhancedRTBeamLimitingOpeningSequence::Item::getRTBeamDelimiterGeometrySequence ( )
inline

get RTBeamDelimiterGeometrySequence (300a,064c)

Returns
reference to sequence element

◆ getRTBeamDelimiterGeometrySequence() [2/2]

const DRTRTBeamDelimiterGeometrySequence & DRTEnhancedRTBeamLimitingOpeningSequence::Item::getRTBeamDelimiterGeometrySequence ( ) const
inline

get RTBeamDelimiterGeometrySequence (300a,064c)

Returns
const reference to sequence element

◆ getRTBeamLimitingDeviceOffset()

OFCondition DRTEnhancedRTBeamLimitingOpeningSequence::Item::getRTBeamLimitingDeviceOffset ( Float64 &  value,
const unsigned long  pos = 0 
) const

get RTBeamLimitingDeviceOffset (300a,064b)

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

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTEnhancedRTBeamLimitingOpeningSequence::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 & DRTEnhancedRTBeamLimitingOpeningSequence::Item::operator= ( const Item copy)

assignment operator

Parameters
copyitem object to be copied
Returns
reference to this object

◆ read()

OFCondition DRTEnhancedRTBeamLimitingOpeningSequence::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

◆ setParallelRTBeamDelimiterPositions()

OFCondition DRTEnhancedRTBeamLimitingOpeningSequence::Item::setParallelRTBeamDelimiterPositions ( const Float64  value,
const unsigned long  pos = 0 
)

set ParallelRTBeamDelimiterPositions (300a,064a)

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

◆ setReferencedDeviceIndex()

OFCondition DRTEnhancedRTBeamLimitingOpeningSequence::Item::setReferencedDeviceIndex ( const Uint16  value,
const unsigned long  pos = 0 
)

set ReferencedDeviceIndex (300a,0607)

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

◆ setRTBeamLimitingDeviceOffset()

OFCondition DRTEnhancedRTBeamLimitingOpeningSequence::Item::setRTBeamLimitingDeviceOffset ( const Float64  value,
const unsigned long  pos = 0 
)

set RTBeamLimitingDeviceOffset (300a,064b)

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

◆ write()

OFCondition DRTEnhancedRTBeamLimitingOpeningSequence::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 Dec 19 2023 for DCMTK Version 3.6.8 by Doxygen 1.9.4