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 | getCumulativeDoseToDoseReference (OFString &value, const signed long pos=0) const |
| | get CumulativeDoseToDoseReference (3008,0052)
|
| |
| OFCondition | getCumulativeDoseToDoseReference (Float64 &value, const unsigned long pos=0) const |
| | get CumulativeDoseToDoseReference (3008,0052)
|
| |
| OFCondition | getDoseReferenceDescription (OFString &value, const signed long pos=0) const |
| | get DoseReferenceDescription (300a,0016)
|
| |
| OFCondition | getReferencedDoseReferenceNumber (OFString &value, const signed long pos=0) const |
| | get ReferencedDoseReferenceNumber (300c,0051)
|
| |
| OFCondition | getReferencedDoseReferenceNumber (Sint32 &value, const unsigned long pos=0) const |
| | get ReferencedDoseReferenceNumber (300c,0051)
|
| |
| OFCondition | setCumulativeDoseToDoseReference (const OFString &value, const OFBool check=OFTrue) |
| | set CumulativeDoseToDoseReference (3008,0052)
|
| |
| OFCondition | setDoseReferenceDescription (const OFString &value, const OFBool check=OFTrue) |
| | set DoseReferenceDescription (300a,0016)
|
| |
| OFCondition | setReferencedDoseReferenceNumber (const OFString &value, const OFBool check=OFTrue) |
| | set ReferencedDoseReferenceNumber (300c,0051)
|
| |
|
|
OFBool | EmptyDefaultItem |
| | internal flag used to mark the empty default item
|
| |
|
DcmDecimalString | CumulativeDoseToDoseReference |
| | CumulativeDoseToDoseReference (3008,0052) vr=DS, vm=1, type=1.
|
| |
|
DcmLongString | DoseReferenceDescription |
| | DoseReferenceDescription (300a,0016) vr=LO, vm=1, type=3.
|
| |
|
DcmIntegerString | ReferencedDoseReferenceNumber |
| | ReferencedDoseReferenceNumber (300c,0051) vr=IS, vm=1, type=3.
|
| |
|
| 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]
| DRTTreatmentSummaryCalculatedDoseReferenceSequence::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]
| DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::Item |
( |
const Item & | copy | ) |
|
copy constructor
- Parameters
-
| copy | item object to be copied |
References Item().
◆ getCumulativeDoseToDoseReference() [1/2]
| OFCondition DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::getCumulativeDoseToDoseReference |
( |
Float64 & | value, |
|
|
const unsigned long | pos = 0 ) const |
get CumulativeDoseToDoseReference (3008,0052)
- 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
◆ getCumulativeDoseToDoseReference() [2/2]
| OFCondition DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::getCumulativeDoseToDoseReference |
( |
OFString & | value, |
|
|
const signed long | pos = 0 ) const |
get CumulativeDoseToDoseReference (3008,0052)
- 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
◆ getDoseReferenceDescription()
| OFCondition DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::getDoseReferenceDescription |
( |
OFString & | value, |
|
|
const signed long | pos = 0 ) const |
get DoseReferenceDescription (300a,0016)
- 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
◆ getReferencedDoseReferenceNumber() [1/2]
| OFCondition DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::getReferencedDoseReferenceNumber |
( |
OFString & | value, |
|
|
const signed long | pos = 0 ) const |
get ReferencedDoseReferenceNumber (300c,0051)
- 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
◆ getReferencedDoseReferenceNumber() [2/2]
| OFCondition DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::getReferencedDoseReferenceNumber |
( |
Sint32 & | value, |
|
|
const unsigned long | pos = 0 ) const |
get ReferencedDoseReferenceNumber (300c,0051)
- 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 DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::isEmpty |
( |
| ) |
|
check if item is empty
- Returns
- OFTrue if item is empty, OFFalse otherwise
◆ isValid()
| OFBool DRTTreatmentSummaryCalculatedDoseReferenceSequence::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 & DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::operator= |
( |
const Item & | copy | ) |
|
assignment operator
- Parameters
-
| copy | item object to be copied |
- Returns
- reference to this object
References Item().
◆ read()
| OFCondition DRTTreatmentSummaryCalculatedDoseReferenceSequence::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
◆ setCumulativeDoseToDoseReference()
| OFCondition DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::setCumulativeDoseToDoseReference |
( |
const OFString & | value, |
|
|
const OFBool | check = OFTrue ) |
set CumulativeDoseToDoseReference (3008,0052)
- Parameters
-
| value | value to be set (single value only) or "" for no value |
| check | check 'value' for conformance with VR (DS) and VM (1) if enabled |
- Returns
- status, EC_Normal if successful, an error code otherwise
◆ setDoseReferenceDescription()
| OFCondition DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::setDoseReferenceDescription |
( |
const OFString & | value, |
|
|
const OFBool | check = OFTrue ) |
set DoseReferenceDescription (300a,0016)
- 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
◆ setReferencedDoseReferenceNumber()
| OFCondition DRTTreatmentSummaryCalculatedDoseReferenceSequence::Item::setReferencedDoseReferenceNumber |
( |
const OFString & | value, |
|
|
const OFBool | check = OFTrue ) |
set ReferencedDoseReferenceNumber (300c,0051)
- 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()
| OFCondition DRTTreatmentSummaryCalculatedDoseReferenceSequence::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/drttscds.h