DCMTK  Version 3.6.2
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes | List of all members
DRTROIContourSequence::Item Class Reference

Item class. More...

+ Inheritance diagram for DRTROIContourSequence::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 getROIDisplayColor (OFString &value, const signed long pos=0) const
 get ROIDisplayColor (3006,002a) More...
 
OFCondition getROIDisplayColor (Sint32 &value, const unsigned long pos=0) const
 get ROIDisplayColor (3006,002a) More...
 
OFCondition getRecommendedDisplayCIELabValue (Uint16 &value, const unsigned long pos=0) const
 get RecommendedDisplayCIELabValue (0062,000d) More...
 
OFCondition getRecommendedDisplayGrayscaleValue (Uint16 &value, const unsigned long pos=0) const
 get RecommendedDisplayGrayscaleValue (0062,000c) 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...
 
DRTContourSequencegetContourSequence ()
 get ContourSequence (3006,0040) More...
 
const DRTContourSequencegetContourSequence () const
 get ContourSequence (3006,0040) More...
 
OFCondition setROIDisplayColor (const OFString &value, const OFBool check=OFTrue)
 set ROIDisplayColor (3006,002a) More...
 
OFCondition setRecommendedDisplayCIELabValue (const Uint16 value, const unsigned long pos=0)
 set RecommendedDisplayCIELabValue (0062,000d) More...
 
OFCondition setRecommendedDisplayGrayscaleValue (const Uint16 value, const unsigned long pos=0)
 set RecommendedDisplayGrayscaleValue (0062,000c) 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
 
DRTContourSequence ContourSequence
 ContourSequence (3006,0040) vr=SQ, vm=1, type=3.
 
DcmIntegerString ROIDisplayColor
 ROIDisplayColor (3006,002a) vr=IS, vm=3, type=3.
 
DcmUnsignedShort RecommendedDisplayCIELabValue
 RecommendedDisplayCIELabValue (0062,000d) vr=US, vm=3, type=3.
 
DcmUnsignedShort RecommendedDisplayGrayscaleValue
 RecommendedDisplayGrayscaleValue (0062,000c) vr=US, vm=1, type=3.
 
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

◆ Item() [1/2]

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

(default) constructor

Parameters
emptyDefaultItemflag used to mark the empty default item

◆ Item() [2/2]

DRTROIContourSequence::Item::Item ( const Item copy)

copy constructor

Parameters
copyitem object to be copied

Member Function Documentation

◆ getContourSequence() [1/2]

DRTContourSequence& DRTROIContourSequence::Item::getContourSequence ( )
inline

get ContourSequence (3006,0040)

Returns
reference to sequence element

◆ getContourSequence() [2/2]

const DRTContourSequence& DRTROIContourSequence::Item::getContourSequence ( ) const
inline

get ContourSequence (3006,0040)

Returns
const reference to sequence element

◆ getRecommendedDisplayCIELabValue()

OFCondition DRTROIContourSequence::Item::getRecommendedDisplayCIELabValue ( Uint16 &  value,
const unsigned long  pos = 0 
) const

get RecommendedDisplayCIELabValue (0062,000d)

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

◆ getRecommendedDisplayGrayscaleValue()

OFCondition DRTROIContourSequence::Item::getRecommendedDisplayGrayscaleValue ( Uint16 &  value,
const unsigned long  pos = 0 
) const

get RecommendedDisplayGrayscaleValue (0062,000c)

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

◆ getReferencedROINumber() [1/2]

OFCondition DRTROIContourSequence::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

◆ getReferencedROINumber() [2/2]

OFCondition DRTROIContourSequence::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

◆ getROIDisplayColor() [1/2]

OFCondition DRTROIContourSequence::Item::getROIDisplayColor ( OFString value,
const signed long  pos = 0 
) const

get ROIDisplayColor (3006,002a)

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

◆ getROIDisplayColor() [2/2]

OFCondition DRTROIContourSequence::Item::getROIDisplayColor ( Sint32 &  value,
const unsigned long  pos = 0 
) const

get ROIDisplayColor (3006,002a)

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

◆ isEmpty()

OFBool DRTROIContourSequence::Item::isEmpty ( )

check if item is empty

Returns
OFTrue if item is empty, OFFalse otherwise

◆ isValid()

OFBool DRTROIContourSequence::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& DRTROIContourSequence::Item::operator= ( const Item copy)

assigment operator

Parameters
copyitem object to be copied
Returns
reference to this object

◆ read()

OFCondition DRTROIContourSequence::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

◆ setRecommendedDisplayCIELabValue()

OFCondition DRTROIContourSequence::Item::setRecommendedDisplayCIELabValue ( const Uint16  value,
const unsigned long  pos = 0 
)

set RecommendedDisplayCIELabValue (0062,000d)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=3
Returns
status, EC_Normal if successful, an error code otherwise

◆ setRecommendedDisplayGrayscaleValue()

OFCondition DRTROIContourSequence::Item::setRecommendedDisplayGrayscaleValue ( const Uint16  value,
const unsigned long  pos = 0 
)

set RecommendedDisplayGrayscaleValue (0062,000c)

Parameters
valuevalue to be set (should be valid for this VR)
posindex of the value to be set (0..vm-1), vm=1
Returns
status, EC_Normal if successful, an error code otherwise

◆ setReferencedROINumber()

OFCondition DRTROIContourSequence::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

◆ setROIDisplayColor()

OFCondition DRTROIContourSequence::Item::setROIDisplayColor ( const OFString value,
const OFBool  check = OFTrue 
)

set ROIDisplayColor (3006,002a)

Parameters
valuevalue to be set (possibly multi-valued) or "" for no value
checkcheck 'value' for conformance with VR (IS) and VM (3) if enabled
Returns
status, EC_Normal if successful, an error code otherwise

◆ write()

OFCondition DRTROIContourSequence::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 Mon Jul 17 2017 for DCMTK Version 3.6.2 by Doxygen 1.8.13