Item class.
More...
|
| | Item (const OFBool emptyDefaultItem=OFFalse) |
| | (default) constructor
|
| |
| | Item (const Item ©) |
| | copy constructor
|
| |
|
virtual | ~Item () |
| | destructor
|
| |
| Item & | operator= (const Item ©) |
| | assignment 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 | getAccessoryCode (OFString &value, const signed long pos=0) const |
| | get AccessoryCode (300a,00f9)
|
| |
| OFCondition | getCompensatorID (OFString &value, const signed long pos=0) const |
| | get CompensatorID (300a,00e5)
|
| |
| OFCondition | getReferencedCompensatorNumber (OFString &value, const signed long pos=0) const |
| | get ReferencedCompensatorNumber (300c,00d0)
|
| |
| OFCondition | getReferencedCompensatorNumber (Sint32 &value, const unsigned long pos=0) const |
| | get ReferencedCompensatorNumber (300c,00d0)
|
| |
| OFCondition | setAccessoryCode (const OFString &value, const OFBool check=OFTrue) |
| | set AccessoryCode (300a,00f9)
|
| |
| OFCondition | setCompensatorID (const OFString &value, const OFBool check=OFTrue) |
| | set CompensatorID (300a,00e5)
|
| |
| OFCondition | setReferencedCompensatorNumber (const OFString &value, const OFBool check=OFTrue) |
| | set ReferencedCompensatorNumber (300c,00d0)
|
| |
|
|
OFBool | EmptyDefaultItem |
| | internal flag used to mark the empty default item
|
| |
|
DcmLongString | AccessoryCode |
| | AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.
|
| |
|
DcmShortString | CompensatorID |
| | CompensatorID (300a,00e5) vr=SH, vm=1, type=3.
|
| |
|
DcmIntegerString | ReferencedCompensatorNumber |
| | ReferencedCompensatorNumber (300c,00d0) vr=IS, vm=1, type=1.
|
| |
|
| virtual | ~DRTTypes () |
| | destructor.
|
| |
| 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.
|
| |
| static OFCondition | getElementFromDataset (DcmItem &dataset, DcmElement &element) |
| | get element from dataset
|
| |
| static OFCondition | getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0) |
| | get string value from element
|
| |
| static OFCondition | getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue) |
| | get string value from dataset
|
| |
| static OFCondition | putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue) |
| | put string value to dataset
|
| |
| 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
|
| |
| 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.
|
| |
| 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.
|
| |
◆ Item() [1/2]
| DRTRecordedCompensatorSequence::Item::Item |
( |
const OFBool | emptyDefaultItem = OFFalse | ) |
|
(default) constructor
- Parameters
-
| emptyDefaultItem | flag used to mark the empty default item |
Referenced by Item(), and operator=().
◆ Item() [2/2]
| DRTRecordedCompensatorSequence::Item::Item |
( |
const Item & | copy | ) |
|
copy constructor
- Parameters
-
| copy | item object to be copied |
References Item().
◆ getAccessoryCode()
| OFCondition DRTRecordedCompensatorSequence::Item::getAccessoryCode |
( |
OFString & | value, |
|
|
const signed long | pos = 0 ) const |
get AccessoryCode (300a,00f9)
- 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
◆ getCompensatorID()
| OFCondition DRTRecordedCompensatorSequence::Item::getCompensatorID |
( |
OFString & | value, |
|
|
const signed long | pos = 0 ) const |
get CompensatorID (300a,00e5)
- 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
◆ getReferencedCompensatorNumber() [1/2]
| OFCondition DRTRecordedCompensatorSequence::Item::getReferencedCompensatorNumber |
( |
OFString & | value, |
|
|
const signed long | pos = 0 ) const |
get ReferencedCompensatorNumber (300c,00d0)
- 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
◆ getReferencedCompensatorNumber() [2/2]
| OFCondition DRTRecordedCompensatorSequence::Item::getReferencedCompensatorNumber |
( |
Sint32 & | value, |
|
|
const unsigned long | pos = 0 ) const |
get ReferencedCompensatorNumber (300c,00d0)
- 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
◆ isEmpty()
| OFBool DRTRecordedCompensatorSequence::Item::isEmpty |
( |
| ) |
|
check if item is empty
- Returns
- OFTrue if item is empty, OFFalse otherwise
◆ isValid()
| OFBool DRTRecordedCompensatorSequence::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 & DRTRecordedCompensatorSequence::Item::operator= |
( |
const Item & | copy | ) |
|
assignment operator
- Parameters
-
| copy | item object to be copied |
- Returns
- reference to this object
References Item().
◆ read()
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
◆ setAccessoryCode()
| OFCondition DRTRecordedCompensatorSequence::Item::setAccessoryCode |
( |
const OFString & | value, |
|
|
const OFBool | check = OFTrue ) |
set AccessoryCode (300a,00f9)
- Parameters
-
| value | value to be set (single value only) or "" for no value |
| check | check 'value' for conformance with VR (LO) and VM (1) if enabled |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ setCompensatorID()
| OFCondition DRTRecordedCompensatorSequence::Item::setCompensatorID |
( |
const OFString & | value, |
|
|
const OFBool | check = OFTrue ) |
set CompensatorID (300a,00e5)
- Parameters
-
| value | value to be set (single value only) or "" for no value |
| check | check 'value' for conformance with VR (SH) and VM (1) if enabled |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ setReferencedCompensatorNumber()
| OFCondition DRTRecordedCompensatorSequence::Item::setReferencedCompensatorNumber |
( |
const OFString & | value, |
|
|
const OFBool | check = OFTrue ) |
set ReferencedCompensatorNumber (300c,00d0)
- 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
◆ write()
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/drtrcos.h