Item class.
More...
|
| Item (const OFBool emptyDefaultItem=OFFalse) |
| (default) constructor More...
|
|
| Item (const Item ©) |
| copy constructor More...
|
|
virtual | ~Item () |
| destructor
|
|
Item & | operator= (const Item ©) |
| assigment operator More...
|
|
void | clear () |
| clear all internal member variables
|
|
OFBool | isEmpty () |
| check if item is empty More...
|
|
OFBool | isValid () const |
| check if item is valid, i.e. not the empty default item More...
|
|
OFCondition | read (DcmItem &item) |
| read elements from sequence item More...
|
|
OFCondition | write (DcmItem &item) |
| write elements to sequence item More...
|
|
OFCondition | getReferenceImageNumber (OFString &value, const signed long pos=0) const |
| get ReferenceImageNumber (300a,00c8) More...
|
|
OFCondition | getReferenceImageNumber (Sint32 &value, const unsigned long pos=0) const |
| get ReferenceImageNumber (300a,00c8) More...
|
|
OFCondition | getReferencedSOPClassUID (OFString &value, const signed long pos=0) const |
| get ReferencedSOPClassUID (0008,1150) More...
|
|
OFCondition | getReferencedSOPInstanceUID (OFString &value, const signed long pos=0) const |
| get ReferencedSOPInstanceUID (0008,1155) More...
|
|
OFCondition | setReferenceImageNumber (const OFString &value, const OFBool check=OFTrue) |
| set ReferenceImageNumber (300a,00c8) More...
|
|
OFCondition | setReferencedSOPClassUID (const OFString &value, const OFBool check=OFTrue) |
| set ReferencedSOPClassUID (0008,1150) More...
|
|
OFCondition | setReferencedSOPInstanceUID (const OFString &value, const OFBool check=OFTrue) |
| set ReferencedSOPInstanceUID (0008,1155) More...
|
|
|
virtual | ~DRTTypes () |
| destructor. More...
|
|
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. More...
|
|
static OFCondition | getElementFromDataset (DcmItem &dataset, DcmElement &element) |
| get element from dataset More...
|
|
static OFCondition | getStringValueFromElement (const DcmElement &element, OFString &stringValue, const signed long pos=0) |
| get string value from element More...
|
|
static OFCondition | getStringValueFromDataset (DcmItem &dataset, const DcmTagKey &tagKey, OFString &stringValue) |
| get string value from dataset More...
|
|
static OFCondition | putStringValueToDataset (DcmItem &dataset, const DcmTag &tag, const OFString &stringValue, const OFBool allowEmpty=OFTrue) |
| put string value to dataset More...
|
|
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 More...
|
|
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. More...
|
|
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. More...
|
|
DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::Item |
( |
const OFBool |
emptyDefaultItem = OFFalse | ) |
|
(default) constructor
- Parameters
-
emptyDefaultItem | flag used to mark the empty default item |
DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::Item |
( |
const Item & |
copy | ) |
|
copy constructor
- Parameters
-
copy | item object to be copied |
OFCondition DRTReferencedReferenceImageSequenceInRTIonBeamsModule::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
OFCondition DRTReferencedReferenceImageSequenceInRTIonBeamsModule::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
OFCondition DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::getReferenceImageNumber |
( |
OFString & |
value, |
|
|
const signed long |
pos = 0 |
|
) |
| const |
get ReferenceImageNumber (300a,00c8)
- 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 DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::getReferenceImageNumber |
( |
Sint32 & |
value, |
|
|
const unsigned long |
pos = 0 |
|
) |
| const |
get ReferenceImageNumber (300a,00c8)
- 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
OFBool DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::isEmpty |
( |
| ) |
|
check if item is empty
- Returns
- OFTrue if item is empty, OFFalse otherwise
OFBool DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::isValid |
( |
| ) |
const |
check if item is valid, i.e. not the empty default item
- Returns
- OFTrue if item is valid, OFFalse otherwise
Item& DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::operator= |
( |
const Item & |
copy | ) |
|
assigment operator
- Parameters
-
copy | item object to be copied |
- Returns
- reference to this object
OFCondition DRTReferencedReferenceImageSequenceInRTIonBeamsModule::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
OFCondition DRTReferencedReferenceImageSequenceInRTIonBeamsModule::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
OFCondition DRTReferencedReferenceImageSequenceInRTIonBeamsModule::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
OFCondition DRTReferencedReferenceImageSequenceInRTIonBeamsModule::Item::setReferenceImageNumber |
( |
const OFString & |
value, |
|
|
const OFBool |
check = OFTrue |
|
) |
| |
set ReferenceImageNumber (300a,00c8)
- 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 DRTReferencedReferenceImageSequenceInRTIonBeamsModule::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/drtrris6.h