Inheritance diagram for DRTContourSequence::Item:

Public Member Functions
	Item (const OFBool emptyDefaultItem=OFFalse)
	(default) constructor More...

	Item (const Item &copy)
	copy constructor More...

virtual	~Item ()
	destructor

Item &	operator= (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	getAttachedContours (OFString &value, const signed long pos=0) const
	get AttachedContours (3006,0049) More...

OFCondition	getAttachedContours (Sint32 &value, const unsigned long pos=0) const
	get AttachedContours (3006,0049) More...

OFCondition	getContourData (OFString &value, const signed long pos=0) const
	get ContourData (3006,0050) More...

OFCondition	getContourData (Float64 &value, const unsigned long pos=0) const
	get ContourData (3006,0050) More...

OFCondition	getContourData (OFVector< Float64 > &value) const
	get ContourData (3006,0050) More...

OFCondition	getContourGeometricType (OFString &value, const signed long pos=0) const
	get ContourGeometricType (3006,0042) More...

OFCondition	getContourNumber (OFString &value, const signed long pos=0) const
	get ContourNumber (3006,0048) More...

OFCondition	getContourNumber (Sint32 &value, const unsigned long pos=0) const
	get ContourNumber (3006,0048) More...

OFCondition	getContourOffsetVector (OFString &value, const signed long pos=0) const
	get ContourOffsetVector (3006,0045) More...

OFCondition	getContourOffsetVector (Float64 &value, const unsigned long pos=0) const
	get ContourOffsetVector (3006,0045) More...

OFCondition	getContourOffsetVector (OFVector< Float64 > &value) const
	get ContourOffsetVector (3006,0045) More...

OFCondition	getContourSlabThickness (OFString &value, const signed long pos=0) const
	get ContourSlabThickness (3006,0044) More...

OFCondition	getContourSlabThickness (Float64 &value, const unsigned long pos=0) const
	get ContourSlabThickness (3006,0044) More...

OFCondition	getNumberOfContourPoints (OFString &value, const signed long pos=0) const
	get NumberOfContourPoints (3006,0046) More...

OFCondition	getNumberOfContourPoints (Sint32 &value, const unsigned long pos=0) const
	get NumberOfContourPoints (3006,0046) More...

DRTContourImageSequence &	getContourImageSequence ()
	get ContourImageSequence (3006,0016) More...

const DRTContourImageSequence &	getContourImageSequence () const
	get ContourImageSequence (3006,0016) More...

OFCondition	setAttachedContours (const OFString &value, const OFBool check=OFTrue)
	set AttachedContours (3006,0049) More...

OFCondition	setContourData (const OFString &value, const OFBool check=OFTrue)
	set ContourData (3006,0050) More...

OFCondition	setContourGeometricType (const OFString &value, const OFBool check=OFTrue)
	set ContourGeometricType (3006,0042) More...

OFCondition	setContourNumber (const OFString &value, const OFBool check=OFTrue)
	set ContourNumber (3006,0048) More...

OFCondition	setContourOffsetVector (const OFString &value, const OFBool check=OFTrue)
	set ContourOffsetVector (3006,0045) More...

OFCondition	setContourSlabThickness (const OFString &value, const OFBool check=OFTrue)
	set ContourSlabThickness (3006,0044) More...

OFCondition	setNumberOfContourPoints (const OFString &value, const OFBool check=OFTrue)
	set NumberOfContourPoints (3006,0046) More...

Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item

DcmIntegerString	AttachedContours
	AttachedContours (3006,0049) vr=IS, vm=1-n, type=3.

DcmDecimalString	ContourData
	ContourData (3006,0050) vr=DS, vm=3-3n, type=1.

DcmCodeString	ContourGeometricType
	ContourGeometricType (3006,0042) vr=CS, vm=1, type=1.

DRTContourImageSequence	ContourImageSequence
	ContourImageSequence (3006,0016) vr=SQ, vm=1, type=3.

DcmIntegerString	ContourNumber
	ContourNumber (3006,0048) vr=IS, vm=1, type=3.

DcmDecimalString	ContourOffsetVector
	ContourOffsetVector (3006,0045) vr=DS, vm=3, type=3.

DcmDecimalString	ContourSlabThickness
	ContourSlabThickness (3006,0044) vr=DS, vm=1, type=3.

DcmIntegerString	NumberOfContourPoints
	NumberOfContourPoints (3006,0046) 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]

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

(default) constructor

Parameters

emptyDefaultItem flag used to mark the empty default item

◆ Item() [2/2]

DRTContourSequence::Item::Item ( const Item & copy )

copy constructor

Parameters

copy	item object to be copied

Member Function Documentation

◆ getAttachedContours() [1/2]

OFCondition DRTContourSequence::Item::getAttachedContours	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get AttachedContours (3006,0049)

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

◆ getAttachedContours() [2/2]

OFCondition DRTContourSequence::Item::getAttachedContours	(	Sint32 &	value,
		const unsigned long	pos = `0`
	)		const

get AttachedContours (3006,0049)

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

◆ getContourData() [1/3]

OFCondition DRTContourSequence::Item::getContourData	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ContourData (3006,0050)

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

◆ getContourData() [2/3]

OFCondition DRTContourSequence::Item::getContourData	(	Float64 &	value,
		const unsigned long	pos = `0`
	)		const

get ContourData (3006,0050)

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

◆ getContourData() [3/3]

OFCondition DRTContourSequence::Item::getContourData ( OFVector< Float64 > & value ) const

get ContourData (3006,0050)

Parameters

value reference to variable in which the value(s) should be stored

Returns: status, EC_Normal if successful, an error code otherwise

◆ getContourGeometricType()

OFCondition DRTContourSequence::Item::getContourGeometricType	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ContourGeometricType (3006,0042)

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

◆ getContourImageSequence() [1/2]

DRTContourImageSequence& DRTContourSequence::Item::getContourImageSequence ( )

inline

get ContourImageSequence (3006,0016)

Returns: reference to sequence element

◆ getContourImageSequence() [2/2]

const DRTContourImageSequence& DRTContourSequence::Item::getContourImageSequence ( ) const

inline

get ContourImageSequence (3006,0016)

Returns: const reference to sequence element

◆ getContourNumber() [1/2]

OFCondition DRTContourSequence::Item::getContourNumber	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ContourNumber (3006,0048)

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

◆ getContourNumber() [2/2]

OFCondition DRTContourSequence::Item::getContourNumber	(	Sint32 &	value,
		const unsigned long	pos = `0`
	)		const

get ContourNumber (3006,0048)

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

◆ getContourOffsetVector() [1/3]

OFCondition DRTContourSequence::Item::getContourOffsetVector	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ContourOffsetVector (3006,0045)

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

◆ getContourOffsetVector() [2/3]

OFCondition DRTContourSequence::Item::getContourOffsetVector	(	Float64 &	value,
		const unsigned long	pos = `0`
	)		const

get ContourOffsetVector (3006,0045)

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

◆ getContourOffsetVector() [3/3]

OFCondition DRTContourSequence::Item::getContourOffsetVector ( OFVector< Float64 > & value ) const

get ContourOffsetVector (3006,0045)

Parameters

value reference to variable in which the value(s) should be stored

Returns: status, EC_Normal if successful, an error code otherwise

◆ getContourSlabThickness() [1/2]

OFCondition DRTContourSequence::Item::getContourSlabThickness	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get ContourSlabThickness (3006,0044)

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

◆ getContourSlabThickness() [2/2]

OFCondition DRTContourSequence::Item::getContourSlabThickness	(	Float64 &	value,
		const unsigned long	pos = `0`
	)		const

get ContourSlabThickness (3006,0044)

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

◆ getNumberOfContourPoints() [1/2]

OFCondition DRTContourSequence::Item::getNumberOfContourPoints	(	OFString &	value,
		const signed long	pos = `0`
	)		const

get NumberOfContourPoints (3006,0046)

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

◆ getNumberOfContourPoints() [2/2]

OFCondition DRTContourSequence::Item::getNumberOfContourPoints	(	Sint32 &	value,
		const unsigned long	pos = `0`
	)		const

get NumberOfContourPoints (3006,0046)

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 DRTContourSequence::Item::isEmpty ( )

check if item is empty

Returns: OFTrue if item is empty, OFFalse otherwise

◆ isValid()

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

assigment operator

Parameters

copy	item object to be copied

Returns: reference to this object

◆ read()

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

◆ setAttachedContours()

OFCondition DRTContourSequence::Item::setAttachedContours	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set AttachedContours (3006,0049)

Parameters

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (IS) and VM (1-n) if enabled

Returns: status, EC_Normal if successful, an error code otherwise

◆ setContourData()

OFCondition DRTContourSequence::Item::setContourData	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ContourData (3006,0050)

Parameters

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (3-3n) if enabled

Returns: status, EC_Normal if successful, an error code otherwise

◆ setContourGeometricType()

OFCondition DRTContourSequence::Item::setContourGeometricType	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ContourGeometricType (3006,0042)

Parameters

value	value to be set (single value only) or "" for no value
check	check 'value' for conformance with VR (CS) and VM (1) if enabled

Returns: status, EC_Normal if successful, an error code otherwise

◆ setContourNumber()

OFCondition DRTContourSequence::Item::setContourNumber	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ContourNumber (3006,0048)

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

◆ setContourOffsetVector()

OFCondition DRTContourSequence::Item::setContourOffsetVector	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ContourOffsetVector (3006,0045)

Parameters

value	value to be set (possibly multi-valued) or "" for no value
check	check 'value' for conformance with VR (DS) and VM (3) if enabled

Returns: status, EC_Normal if successful, an error code otherwise

◆ setContourSlabThickness()

OFCondition DRTContourSequence::Item::setContourSlabThickness	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ContourSlabThickness (3006,0044)

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

◆ setNumberOfContourPoints()

OFCondition DRTContourSequence::Item::setNumberOfContourPoints	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set NumberOfContourPoints (3006,0046)

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 DRTContourSequence::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/drtcs.h

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Item() [1/2]

◆ Item() [2/2]

Member Function Documentation

◆ getAttachedContours() [1/2]

◆ getAttachedContours() [2/2]

◆ getContourData() [1/3]

◆ getContourData() [2/3]

◆ getContourData() [3/3]

◆ getContourGeometricType()

◆ getContourImageSequence() [1/2]

◆ getContourImageSequence() [2/2]

◆ getContourNumber() [1/2]

◆ getContourNumber() [2/2]

◆ getContourOffsetVector() [1/3]

◆ getContourOffsetVector() [2/3]

◆ getContourOffsetVector() [3/3]

◆ getContourSlabThickness() [1/2]

◆ getContourSlabThickness() [2/2]

◆ getNumberOfContourPoints() [1/2]

◆ getNumberOfContourPoints() [2/2]

◆ isEmpty()

◆ isValid()

◆ operator=()

◆ read()

◆ setAttachedContours()

◆ setContourData()

◆ setContourGeometricType()

◆ setContourNumber()

◆ setContourOffsetVector()

◆ setContourSlabThickness()

◆ setNumberOfContourPoints()

◆ write()