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 | getReferencedPlanOverviewIndex (Uint16 &value, const unsigned long pos=0) const | 
|  | get ReferencedPlanOverviewIndex (300c,0118) 
 | 
|  | 
| 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) 
 | 
|  | 
| DRTReferencedFractionGroupSequence & | getReferencedFractionGroupSequence () | 
|  | get ReferencedFractionGroupSequence (300c,0020) 
 | 
|  | 
| const DRTReferencedFractionGroupSequence & | getReferencedFractionGroupSequence () const | 
|  | get ReferencedFractionGroupSequence (300c,0020) 
 | 
|  | 
| OFCondition | setReferencedPlanOverviewIndex (const Uint16 value, const unsigned long pos=0) | 
|  | set ReferencedPlanOverviewIndex (300c,0118) 
 | 
|  | 
| 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 
 | 
|  | 
| DRTReferencedFractionGroupSequence | ReferencedFractionGroupSequence | 
|  | ReferencedFractionGroupSequence (300c,0020) vr=SQ, vm=1, type=1C. 
 | 
|  | 
| DcmUnsignedShort | ReferencedPlanOverviewIndex | 
|  | ReferencedPlanOverviewIndex (300c,0118) vr=US, 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]
      
        
          | DRTReferencedRTPlanSequence::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]
      
        
          | DRTReferencedRTPlanSequence::Item::Item | ( | const Item & | copy | ) |  | 
      
 
copy constructor 
- Parameters
- 
  
    | copy | item object to be copied |  
 
References Item().
 
 
◆ getReferencedFractionGroupSequence() [1/2]
◆ getReferencedFractionGroupSequence() [2/2]
◆ getReferencedPlanOverviewIndex()
      
        
          | OFCondition DRTReferencedRTPlanSequence::Item::getReferencedPlanOverviewIndex | ( | Uint16 & | value, | 
        
          |  |  | const unsigned long | pos = 0 ) const | 
      
 
get ReferencedPlanOverviewIndex (300c,0118) 
- 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 
 
 
◆ getReferencedSOPClassUID()
      
        
          | OFCondition DRTReferencedRTPlanSequence::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 DRTReferencedRTPlanSequence::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 DRTReferencedRTPlanSequence::Item::isEmpty | ( |  | ) |  | 
      
 
check if item is empty 
- Returns
- OFTrue if item is empty, OFFalse otherwise 
 
 
◆ isValid()
      
        
          | OFBool DRTReferencedRTPlanSequence::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 & DRTReferencedRTPlanSequence::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 
 
 
◆ setReferencedPlanOverviewIndex()
      
        
          | OFCondition DRTReferencedRTPlanSequence::Item::setReferencedPlanOverviewIndex | ( | const Uint16 | value, | 
        
          |  |  | const unsigned long | pos = 0 ) | 
      
 
set ReferencedPlanOverviewIndex (300c,0118) 
- 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 
 
 
◆ setReferencedSOPClassUID()
      
        
          | OFCondition DRTReferencedRTPlanSequence::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 DRTReferencedRTPlanSequence::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()
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/drtrtps1.h