Inheritance diagram for DRTIonBeamLimitingDeviceSequence::Item:
Public Member Functions | |
| Item (const OFBool emptyDefaultItem=OFFalse) | |
| (default) constructor | |
| Item (const Item ©) | |
| copy constructor | |
| virtual | ~Item () |
| destructor | |
| Item & | operator= (const Item ©) |
| assigment operator | |
| void | clear () |
| clear all internal member variables | |
| OFBool | isEmpty () |
| check if item is empty | |
| OFBool | isValid () const |
| check if item is valid, i.e. not the empty default item | |
| OFCondition | read (DcmItem &item) |
| read elements from sequence item | |
| OFCondition | write (DcmItem &item) |
| write elements to sequence item | |
| OFCondition | getIsocenterToBeamLimitingDeviceDistance (Float32 &value, const unsigned long pos=0) const |
| get IsocenterToBeamLimitingDeviceDistance (300a,00bb) | |
| OFCondition | getLeafPositionBoundaries (OFString &value, const signed long pos=0) const |
| get LeafPositionBoundaries (300a,00be) | |
| OFCondition | getLeafPositionBoundaries (Float64 &value, const unsigned long pos=0) const |
| get LeafPositionBoundaries (300a,00be) | |
| OFCondition | getLeafPositionBoundaries (OFVector< Float64 > &value) const |
| get LeafPositionBoundaries (300a,00be) | |
| OFCondition | getNumberOfLeafJawPairs (OFString &value, const signed long pos=0) const |
| get NumberOfLeafJawPairs (300a,00bc) | |
| OFCondition | getNumberOfLeafJawPairs (Sint32 &value, const unsigned long pos=0) const |
| get NumberOfLeafJawPairs (300a,00bc) | |
| OFCondition | getRTBeamLimitingDeviceType (OFString &value, const signed long pos=0) const |
| get RTBeamLimitingDeviceType (300a,00b8) | |
| OFCondition | setIsocenterToBeamLimitingDeviceDistance (const Float32 value, const unsigned long pos=0) |
| set IsocenterToBeamLimitingDeviceDistance (300a,00bb) | |
| OFCondition | setLeafPositionBoundaries (const OFString &value, const OFBool check=OFTrue) |
| set LeafPositionBoundaries (300a,00be) | |
| OFCondition | setNumberOfLeafJawPairs (const OFString &value, const OFBool check=OFTrue) |
| set NumberOfLeafJawPairs (300a,00bc) | |
| OFCondition | setRTBeamLimitingDeviceType (const OFString &value, const OFBool check=OFTrue) |
| set RTBeamLimitingDeviceType (300a,00b8) | |
Private Attributes | |
| OFBool | EmptyDefaultItem |
| internal flag used to mark the empty default item | |
| DcmFloatingPointSingle | IsocenterToBeamLimitingDeviceDistance |
| IsocenterToBeamLimitingDeviceDistance (300a,00bb) vr=FL, vm=1, type=2. | |
| DcmDecimalString | LeafPositionBoundaries |
| LeafPositionBoundaries (300a,00be) vr=DS, vm=3-n, type=1C. | |
| DcmIntegerString | NumberOfLeafJawPairs |
| NumberOfLeafJawPairs (300a,00bc) vr=IS, vm=1, type=1. | |
| DcmCodeString | RTBeamLimitingDeviceType |
| RTBeamLimitingDeviceType (300a,00b8) vr=CS, vm=1, type=1. | |
Detailed Description
Item class.
Constructor & Destructor Documentation
| DRTIonBeamLimitingDeviceSequence::Item::Item | ( | const OFBool | emptyDefaultItem = OFFalse | ) |
(default) constructor
- Parameters:
-
emptyDefaultItem flag used to mark the empty default item
| DRTIonBeamLimitingDeviceSequence::Item::Item | ( | const Item & | copy | ) |
copy constructor
- Parameters:
-
copy item object to be copied
Member Function Documentation
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::getIsocenterToBeamLimitingDeviceDistance | ( | Float32 & | value, |
| const unsigned long | pos = 0 |
||
| ) | const |
get IsocenterToBeamLimitingDeviceDistance (300a,00bb)
- Parameters:
-
value reference to variable in which the value should be stored pos index of the value to get (0..vm-1)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::getLeafPositionBoundaries | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const |
get LeafPositionBoundaries (300a,00be)
- Parameters:
-
value reference to variable in which the value should be stored pos index of the value to get (0..vm-1), -1 for all components
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::getLeafPositionBoundaries | ( | Float64 & | value, |
| const unsigned long | pos = 0 |
||
| ) | const |
get LeafPositionBoundaries (300a,00be)
- Parameters:
-
value reference to variable in which the value should be stored pos index of the value to get (0..vm-1)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::getLeafPositionBoundaries | ( | OFVector< Float64 > & | value | ) | const |
get LeafPositionBoundaries (300a,00be)
- Parameters:
-
value reference to variable in which the value(s) should be stored
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::getNumberOfLeafJawPairs | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const |
get NumberOfLeafJawPairs (300a,00bc)
- Parameters:
-
value reference to variable in which the value should be stored pos index of the value to get (0..vm-1), -1 for all components
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::getNumberOfLeafJawPairs | ( | Sint32 & | value, |
| const unsigned long | pos = 0 |
||
| ) | const |
get NumberOfLeafJawPairs (300a,00bc)
- Parameters:
-
value reference to variable in which the value should be stored pos index of the value to get (0..vm-1)
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::getRTBeamLimitingDeviceType | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const |
get RTBeamLimitingDeviceType (300a,00b8)
- Parameters:
-
value reference to variable in which the value should be stored pos index of the value to get (0..vm-1), -1 for all components
- Returns:
- status, EC_Normal if successful, an error code otherwise
check if item is empty
- Returns:
- OFTrue if item is empty, OFFalse otherwise
| OFBool DRTIonBeamLimitingDeviceSequence::Item::isValid | ( | ) | const |
check if item is valid, i.e. not the empty default item
- Returns:
- OFTrue if item is valid, OFFalse otherwise
assigment operator
- Parameters:
-
copy item object to be copied
read elements from sequence item
- Parameters:
-
item reference to DICOM sequence item from which the elements should be read
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::setIsocenterToBeamLimitingDeviceDistance | ( | const Float32 | value, |
| const unsigned long | pos = 0 |
||
| ) |
set IsocenterToBeamLimitingDeviceDistance (300a,00bb)
- Parameters:
-
value value to be set (should be valid for this VR) pos index of the value to be set (0..vm-1), vm=1
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::setLeafPositionBoundaries | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) |
set LeafPositionBoundaries (300a,00be)
- Parameters:
-
value value to be set (possibly multi-valued) or "" for no value check check 'value' for conformance with VR (DS) and VM (3-n) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::setNumberOfLeafJawPairs | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) |
set NumberOfLeafJawPairs (300a,00bc)
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (IS) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTIonBeamLimitingDeviceSequence::Item::setRTBeamLimitingDeviceType | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) |
set RTBeamLimitingDeviceType (300a,00b8)
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (CS) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
write elements to sequence item
- Parameters:
-
item reference 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:
- dcmrt/include/dcmtk/dcmrt/seq/drtiblds.h