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

Item class. More...

+ Inheritance diagram for DRTParallelRTBeamDelimiterDeviceSequence::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 getNumberOfParallelRTBeamDelimiters (Uint16 &value, const unsigned long pos=0) const
 get NumberOfParallelRTBeamDelimiters (300a,0648) More...
 
OFCondition getParallelRTBeamDelimiterBoundaries (Float64 &value, const unsigned long pos=0) const
 get ParallelRTBeamDelimiterBoundaries (300a,0649) More...
 
OFCondition getParallelRTBeamDelimiterLeafMountingSide (OFString &value, const signed long pos=0) const
 get ParallelRTBeamDelimiterLeafMountingSide (300a,064f) More...
 
OFCondition getParallelRTBeamDelimiterOpeningExtents (Float64 &value, const unsigned long pos=0) const
 get ParallelRTBeamDelimiterOpeningExtents (3008,00a4) More...
 
OFCondition getParallelRTBeamDelimiterOpeningMode (OFString &value, const signed long pos=0) const
 get ParallelRTBeamDelimiterOpeningMode (300a,064e) More...
 
DRTParallelRTBeamDelimiterDeviceOrientationLabelCodeSequencegetParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence ()
 get ParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence (300a,0644) More...
 
const DRTParallelRTBeamDelimiterDeviceOrientationLabelCodeSequencegetParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence () const
 get ParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence (300a,0644) More...
 
OFCondition setNumberOfParallelRTBeamDelimiters (const Uint16 value, const unsigned long pos=0)
 set NumberOfParallelRTBeamDelimiters (300a,0648) More...
 
OFCondition setParallelRTBeamDelimiterBoundaries (const Float64 value, const unsigned long pos=0)
 set ParallelRTBeamDelimiterBoundaries (300a,0649) More...
 
OFCondition setParallelRTBeamDelimiterLeafMountingSide (const OFString &value, const OFBool check=OFTrue)
 set ParallelRTBeamDelimiterLeafMountingSide (300a,064f) More...
 
OFCondition setParallelRTBeamDelimiterOpeningExtents (const Float64 value, const unsigned long pos=0)
 set ParallelRTBeamDelimiterOpeningExtents (3008,00a4) More...
 
OFCondition setParallelRTBeamDelimiterOpeningMode (const OFString &value, const OFBool check=OFTrue)
 set ParallelRTBeamDelimiterOpeningMode (300a,064e) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmUnsignedShort NumberOfParallelRTBeamDelimiters
 NumberOfParallelRTBeamDelimiters (300a,0648) vr=US, vm=1, type=1.
 
DcmFloatingPointDouble ParallelRTBeamDelimiterBoundaries
 ParallelRTBeamDelimiterBoundaries (300a,0649) vr=FD, vm=2-n, type=1.
 
DRTParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence ParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence
 ParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence (300a,0644) vr=SQ, vm=1, type=1.
 
DcmCodeString ParallelRTBeamDelimiterLeafMountingSide
 ParallelRTBeamDelimiterLeafMountingSide (300a,064f) vr=CS, vm=1-n, type=1C.
 
DcmFloatingPointDouble ParallelRTBeamDelimiterOpeningExtents
 ParallelRTBeamDelimiterOpeningExtents (3008,00a4) vr=FD, vm=2-2n, type=1C.
 
DcmCodeString ParallelRTBeamDelimiterOpeningMode
 ParallelRTBeamDelimiterOpeningMode (300a,064e) 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

◆ Item() [1/2]

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item

◆ Item() [2/2]

DRTParallelRTBeamDelimiterDeviceSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

◆ getNumberOfParallelRTBeamDelimiters()

OFCondition DRTParallelRTBeamDelimiterDeviceSequence::Item::getNumberOfParallelRTBeamDelimiters ( Uint16 &  value,
const unsigned long  pos = 0 
) const

get NumberOfParallelRTBeamDelimiters (300a,0648)

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

◆ getParallelRTBeamDelimiterBoundaries()

OFCondition DRTParallelRTBeamDelimiterDeviceSequence::Item::getParallelRTBeamDelimiterBoundaries ( Float64 &  value,
const unsigned long  pos = 0 
) const

get ParallelRTBeamDelimiterBoundaries (300a,0649)

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

◆ getParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence() [1/2]

DRTParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence & DRTParallelRTBeamDelimiterDeviceSequence::Item::getParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence ( )
inline

get ParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence (300a,0644)

Returns
reference to sequence element

◆ getParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence() [2/2]

const DRTParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence & DRTParallelRTBeamDelimiterDeviceSequence::Item::getParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence ( ) const
inline

get ParallelRTBeamDelimiterDeviceOrientationLabelCodeSequence (300a,0644)

Returns
const reference to sequence element

◆ getParallelRTBeamDelimiterLeafMountingSide()

OFCondition DRTParallelRTBeamDelimiterDeviceSequence::Item::getParallelRTBeamDelimiterLeafMountingSide ( OFString value,
const signed long  pos = 0 
) const

get ParallelRTBeamDelimiterLeafMountingSide (300a,064f)

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

◆ getParallelRTBeamDelimiterOpeningExtents()

OFCondition DRTParallelRTBeamDelimiterDeviceSequence::Item::getParallelRTBeamDelimiterOpeningExtents ( Float64 &  value,
const unsigned long  pos = 0 
) const

get ParallelRTBeamDelimiterOpeningExtents (3008,00a4)

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

◆ getParallelRTBeamDelimiterOpeningMode()

OFCondition DRTParallelRTBeamDelimiterDeviceSequence::Item::getParallelRTBeamDelimiterOpeningMode ( OFString value,
const signed long  pos = 0 
) const

get ParallelRTBeamDelimiterOpeningMode (300a,064e)

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

◆ isEmpty()

OFBool DRTParallelRTBeamDelimiterDeviceSequence::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise

◆ isValid()

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

assignment operator

Parameters
copyitem object to be copied
Returns
reference to this object

◆ read()

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

◆ setNumberOfParallelRTBeamDelimiters()

OFCondition DRTParallelRTBeamDelimiterDeviceSequence::Item::setNumberOfParallelRTBeamDelimiters ( const Uint16  value,
const unsigned long  pos = 0 
)

set NumberOfParallelRTBeamDelimiters (300a,0648)

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

◆ setParallelRTBeamDelimiterBoundaries()

OFCondition DRTParallelRTBeamDelimiterDeviceSequence::Item::setParallelRTBeamDelimiterBoundaries ( const Float64  value,
const unsigned long  pos = 0 
)

set ParallelRTBeamDelimiterBoundaries (300a,0649)

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

◆ setParallelRTBeamDelimiterLeafMountingSide()

OFCondition DRTParallelRTBeamDelimiterDeviceSequence::Item::setParallelRTBeamDelimiterLeafMountingSide ( const OFString value,
const OFBool  check = OFTrue 
)

set ParallelRTBeamDelimiterLeafMountingSide (300a,064f)

Parameters
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (CS) and VM (1-n) if enabled
Returns
status, EC_Normal if successful, an error code otherwise

◆ setParallelRTBeamDelimiterOpeningExtents()

OFCondition DRTParallelRTBeamDelimiterDeviceSequence::Item::setParallelRTBeamDelimiterOpeningExtents ( const Float64  value,
const unsigned long  pos = 0 
)

set ParallelRTBeamDelimiterOpeningExtents (3008,00a4)

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

◆ setParallelRTBeamDelimiterOpeningMode()

OFCondition DRTParallelRTBeamDelimiterDeviceSequence::Item::setParallelRTBeamDelimiterOpeningMode ( const OFString value,
const OFBool  check = OFTrue 
)

set ParallelRTBeamDelimiterOpeningMode (300a,064e)

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

◆ write()

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