DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Attributes | List of all members
DRTDVHReferencedROISequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTDVHReferencedROISequence::Item:

Public Member Functions

 Item (const OFBool emptyDefaultItem=OFFalse)
 (default) constructor More...
 
 Item (const Item &copy)
 copy constructor More...
 
virtual ~Item ()
 destructor
 
Itemoperator= (const Item &copy)
 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 getDVHROIContributionType (OFString &value, const signed long pos=0) const
 get DVHROIContributionType (3004,0062) More...
 
OFCondition getReferencedROINumber (OFString &value, const signed long pos=0) const
 get ReferencedROINumber (3006,0084) More...
 
OFCondition getReferencedROINumber (Sint32 &value, const unsigned long pos=0) const
 get ReferencedROINumber (3006,0084) More...
 
OFCondition setDVHROIContributionType (const OFString &value, const OFBool check=OFTrue)
 set DVHROIContributionType (3004,0062) More...
 
OFCondition setReferencedROINumber (const OFString &value, const OFBool check=OFTrue)
 set ReferencedROINumber (3006,0084) More...
 

Private Attributes

OFBool EmptyDefaultItem
 internal flag used to mark the empty default item
 
DcmCodeString DVHROIContributionType
 DVHROIContributionType (3004,0062) vr=CS, vm=1, type=1.
 
DcmIntegerString ReferencedROINumber
 ReferencedROINumber (3006,0084) vr=IS, vm=1, type=1.
 

Additional Inherited Members

- Protected Member Functions inherited from DRTTypes
virtual ~DRTTypes ()
 destructor. More...
 
- Static Protected Member Functions inherited from DRTTypes
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...
 

Detailed Description

Item class.

Constructor & Destructor Documentation

DRTDVHReferencedROISequence::Item::Item ( const OFBool  emptyDefaultItem = OFFalse)

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item
DRTDVHReferencedROISequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

OFCondition DRTDVHReferencedROISequence::Item::getDVHROIContributionType ( OFString value,
const signed long  pos = 0 
) const

get DVHROIContributionType (3004,0062)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDVHReferencedROISequence::Item::getReferencedROINumber ( OFString value,
const signed long  pos = 0 
) const

get ReferencedROINumber (3006,0084)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1), -1 for all components
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDVHReferencedROISequence::Item::getReferencedROINumber ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get ReferencedROINumber (3006,0084)

Parameters
valuereference to variable in which the value should be stored
posindex of the value to get (0..vm-1)
Returns
status, EC_Normal if successful, an error code otherwise
OFBool DRTDVHReferencedROISequence::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise
OFBool DRTDVHReferencedROISequence::Item::isValid ( ) const

check if item is valid, i.e. not the empty default item

Returns
OFTrue if item is valid, OFFalse otherwise
Item& DRTDVHReferencedROISequence::Item::operator= ( const Item copy)

assigment operator

Parameters
copyitem object to be copied
Returns
reference to this object
OFCondition DRTDVHReferencedROISequence::Item::read ( DcmItem item)

read elements from sequence item

Parameters
itemreference to DICOM sequence item from which the elements should be read
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDVHReferencedROISequence::Item::setDVHROIContributionType ( const OFString value,
const OFBool  check = OFTrue 
)

set DVHROIContributionType (3004,0062)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (CS) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDVHReferencedROISequence::Item::setReferencedROINumber ( const OFString value,
const OFBool  check = OFTrue 
)

set ReferencedROINumber (3006,0084)

Parameters
valuevalue to be set (single value only) or "" for no value
checkcheck 'value' for conformance with VR (IS) and VM (1) if enabled
Returns
status, EC_Normal if successful, an error code otherwise
OFCondition DRTDVHReferencedROISequence::Item::write ( DcmItem item)

write elements to sequence item

Parameters
itemreference 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:


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8