Inheritance diagram for DRTCorrectedParameterSequence::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 | getCorrectionValue (Float32 &value, const unsigned long pos=0) const |
| get CorrectionValue (3008,006a) | |
| OFCondition | getParameterItemIndex (OFString &value, const signed long pos=0) const |
| get ParameterItemIndex (3008,0063) | |
| OFCondition | getParameterItemIndex (Sint32 &value, const unsigned long pos=0) const |
| get ParameterItemIndex (3008,0063) | |
| OFCondition | getParameterPointer (OFString &value, const signed long pos=0) const |
| get ParameterPointer (3008,0065) | |
| OFCondition | getParameterSequencePointer (OFString &value, const signed long pos=0) const |
| get ParameterSequencePointer (3008,0061) | |
| OFCondition | setCorrectionValue (const Float32 value, const unsigned long pos=0) |
| set CorrectionValue (3008,006a) | |
| OFCondition | setParameterItemIndex (const OFString &value, const OFBool check=OFTrue) |
| set ParameterItemIndex (3008,0063) | |
| OFCondition | setParameterPointer (const OFString &value, const OFBool check=OFTrue) |
| set ParameterPointer (3008,0065) | |
| OFCondition | setParameterSequencePointer (const OFString &value, const OFBool check=OFTrue) |
| set ParameterSequencePointer (3008,0061) | |
Private Attributes | |
| OFBool | EmptyDefaultItem |
| internal flag used to mark the empty default item | |
| DcmFloatingPointSingle | CorrectionValue |
| CorrectionValue (3008,006a) vr=FL, vm=1, type=1. | |
| DcmIntegerString | ParameterItemIndex |
| ParameterItemIndex (3008,0063) vr=IS, vm=1, type=1. | |
| DcmAttributeTag | ParameterPointer |
| ParameterPointer (3008,0065) vr=AT, vm=1, type=1. | |
| DcmAttributeTag | ParameterSequencePointer |
| ParameterSequencePointer (3008,0061) vr=AT, vm=1, type=1. | |
Detailed Description
Item class.
Constructor & Destructor Documentation
| DRTCorrectedParameterSequence::Item::Item | ( | const OFBool | emptyDefaultItem = OFFalse | ) |
(default) constructor
- Parameters:
-
emptyDefaultItem flag used to mark the empty default item
| DRTCorrectedParameterSequence::Item::Item | ( | const Item & | copy | ) |
copy constructor
- Parameters:
-
copy item object to be copied
Member Function Documentation
| OFCondition DRTCorrectedParameterSequence::Item::getCorrectionValue | ( | Float32 & | value, |
| const unsigned long | pos = 0 |
||
| ) | const |
get CorrectionValue (3008,006a)
- 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 DRTCorrectedParameterSequence::Item::getParameterItemIndex | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const |
get ParameterItemIndex (3008,0063)
- 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 DRTCorrectedParameterSequence::Item::getParameterItemIndex | ( | Sint32 & | value, |
| const unsigned long | pos = 0 |
||
| ) | const |
get ParameterItemIndex (3008,0063)
- 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 DRTCorrectedParameterSequence::Item::getParameterPointer | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const |
get ParameterPointer (3008,0065)
- 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 DRTCorrectedParameterSequence::Item::getParameterSequencePointer | ( | OFString & | value, |
| const signed long | pos = 0 |
||
| ) | const |
get ParameterSequencePointer (3008,0061)
- 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
| OFBool DRTCorrectedParameterSequence::Item::isEmpty | ( | ) |
check if item is empty
- Returns:
- OFTrue if item is empty, OFFalse otherwise
| OFBool DRTCorrectedParameterSequence::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 DRTCorrectedParameterSequence::Item::setCorrectionValue | ( | const Float32 | value, |
| const unsigned long | pos = 0 |
||
| ) |
set CorrectionValue (3008,006a)
- 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 DRTCorrectedParameterSequence::Item::setParameterItemIndex | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) |
set ParameterItemIndex (3008,0063)
- 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 DRTCorrectedParameterSequence::Item::setParameterPointer | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) |
set ParameterPointer (3008,0065)
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (AT) and VM (1) if enabled
- Returns:
- status, EC_Normal if successful, an error code otherwise
| OFCondition DRTCorrectedParameterSequence::Item::setParameterSequencePointer | ( | const OFString & | value, |
| const OFBool | check = OFTrue |
||
| ) |
set ParameterSequencePointer (3008,0061)
- Parameters:
-
value value to be set (single value only) or "" for no value check check 'value' for conformance with VR (AT) 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/drtcpas.h