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 | getReferencedSOPClassUID (OFString &value, const signed long pos=0) const |
| | get ReferencedSOPClassUID (0008,1150)
|
| |
| OFCondition | getReferencedSOPInstanceUID (OFString &value, const signed long pos=0) const |
| | get ReferencedSOPInstanceUID (0008,1155)
|
| |
| DRTReferencedBeamSequenceInRTDoseModule & | getReferencedBeamSequence () |
| | get ReferencedBeamSequence (300c,0004)
|
| |
| const DRTReferencedBeamSequenceInRTDoseModule & | getReferencedBeamSequence () const |
| | get ReferencedBeamSequence (300c,0004)
|
| |
| OFCondition | setReferencedSOPClassUID (const OFString &value, const OFBool check=OFTrue) |
| | set ReferencedSOPClassUID (0008,1150)
|
| |
| OFCondition | setReferencedSOPInstanceUID (const OFString &value, const OFBool check=OFTrue) |
| | set ReferencedSOPInstanceUID (0008,1155)
|
| |
|
|
OFBool | EmptyDefaultItem |
| | internal flag used to mark the empty default item
|
| |
|
DRTReferencedBeamSequenceInRTDoseModule | ReferencedBeamSequence |
| | ReferencedBeamSequence (300c,0004) vr=SQ, vm=1, type=1C.
|
| |
|
DcmUniqueIdentifier | ReferencedSOPClassUID |
| | ReferencedSOPClassUID (0008,1150) vr=UI, vm=1, type=1.
|
| |
|
DcmUniqueIdentifier | ReferencedSOPInstanceUID |
| | ReferencedSOPInstanceUID (0008,1155) vr=UI, 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]
| DRTReferencedTreatmentRecordSequenceInRTDoseModule::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]
| DRTReferencedTreatmentRecordSequenceInRTDoseModule::Item::Item |
( |
const Item & | copy | ) |
|
copy constructor
- Parameters
-
| copy | item object to be copied |
References Item().
◆ getReferencedBeamSequence() [1/2]
get ReferencedBeamSequence (300c,0004)
- Returns
- reference to sequence element
References ReferencedBeamSequence.
◆ getReferencedBeamSequence() [2/2]
get ReferencedBeamSequence (300c,0004)
- Returns
- const reference to sequence element
References ReferencedBeamSequence.
◆ getReferencedSOPClassUID()
| OFCondition DRTReferencedTreatmentRecordSequenceInRTDoseModule::Item::getReferencedSOPClassUID |
( |
OFString & | value, |
|
|
const signed long | pos = 0 ) const |
get ReferencedSOPClassUID (0008,1150)
- 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
◆ getReferencedSOPInstanceUID()
| OFCondition DRTReferencedTreatmentRecordSequenceInRTDoseModule::Item::getReferencedSOPInstanceUID |
( |
OFString & | value, |
|
|
const signed long | pos = 0 ) const |
get ReferencedSOPInstanceUID (0008,1155)
- 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
◆ isEmpty()
| OFBool DRTReferencedTreatmentRecordSequenceInRTDoseModule::Item::isEmpty |
( |
| ) |
|
check if item is empty
- Returns
- OFTrue if item is empty, OFFalse otherwise
◆ isValid()
| OFBool DRTReferencedTreatmentRecordSequenceInRTDoseModule::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 & DRTReferencedTreatmentRecordSequenceInRTDoseModule::Item::operator= |
( |
const Item & | copy | ) |
|
assignment operator
- Parameters
-
| copy | item object to be copied |
- Returns
- reference to this object
References Item().
◆ read()
| OFCondition DRTReferencedTreatmentRecordSequenceInRTDoseModule::Item::read |
( |
DcmItem & | item | ) |
|
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
◆ setReferencedSOPClassUID()
| OFCondition DRTReferencedTreatmentRecordSequenceInRTDoseModule::Item::setReferencedSOPClassUID |
( |
const OFString & | value, |
|
|
const OFBool | check = OFTrue ) |
set ReferencedSOPClassUID (0008,1150)
- Parameters
-
| value | value to be set (single value only) or "" for no value |
| check | check 'value' for conformance with VR (UI) and VM (1) if enabled |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ setReferencedSOPInstanceUID()
| OFCondition DRTReferencedTreatmentRecordSequenceInRTDoseModule::Item::setReferencedSOPInstanceUID |
( |
const OFString & | value, |
|
|
const OFBool | check = OFTrue ) |
set ReferencedSOPInstanceUID (0008,1155)
- Parameters
-
| value | value to be set (single value only) or "" for no value |
| check | check 'value' for conformance with VR (UI) and VM (1) if enabled |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ write()
| OFCondition DRTReferencedTreatmentRecordSequenceInRTDoseModule::Item::write |
( |
DcmItem & | item | ) |
|
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/drtrtrs1.h