DRTModalityLUTSequence::Item Class Reference

Item class. More...

Inheritance diagram for DRTModalityLUTSequence::Item:

List of all members.

Public Member Functions
	Item (const OFBool emptyDefaultItem=OFFalse)
	(default) constructor
	Item (const Item &copy)
	copy constructor
virtual	~Item ()
	destructor
Item &	operator= (const Item &copy)
	assigment 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	getLUTData (Uint16 *&value, unsigned long *count=NULL) const
	get LUTData (0028,3006)
OFCondition	getLUTDescriptor (Uint16 &value, const unsigned long pos=0) const
	get LUTDescriptor (0028,3002)
OFCondition	getLUTExplanation (OFString &value, const signed long pos=0) const
	get LUTExplanation (0028,3003)
OFCondition	getModalityLUTType (OFString &value, const signed long pos=0) const
	get ModalityLUTType (0028,3004)
OFCondition	setLUTData (const Uint16 *value, const unsigned long count)
	set LUTData (0028,3006)
OFCondition	setLUTDescriptor (const Uint16 value, const unsigned long pos=0)
	set LUTDescriptor (0028,3002)
OFCondition	setLUTExplanation (const OFString &value, const OFBool check=OFTrue)
	set LUTExplanation (0028,3003)
OFCondition	setModalityLUTType (const OFString &value, const OFBool check=OFTrue)
	set ModalityLUTType (0028,3004)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmOtherByteOtherWord	LUTData
	LUTData (0028,3006) vr=US_SS_OW, vm=1-n, type=1C.
DcmUnsignedShort	LUTDescriptor
	LUTDescriptor (0028,3002) vr=US_SS, vm=3, type=1C.
DcmLongString	LUTExplanation
	LUTExplanation (0028,3003) vr=LO, vm=1, type=3.
DcmLongString	ModalityLUTType
	ModalityLUTType (0028,3004) vr=LO, vm=1, type=1C.

---

Detailed Description

Item class.

---

Constructor & Destructor Documentation

DRTModalityLUTSequence::Item::Item

(

const OFBool

emptyDefaultItem = OFFalse

)

(default) constructor

Parameters:

emptyDefaultItem

flag used to mark the empty default item

DRTModalityLUTSequence::Item::Item

(

const Item &

copy

)

copy constructor

Parameters:

copy	item object to be copied

---

Member Function Documentation

OFCondition DRTModalityLUTSequence::Item::getLUTData	(	Uint16 *&	value,
		unsigned long *	count = NULL
	)		const

get LUTData (0028,3006)

Parameters:

value	reference to variable in which the value should be stored
count	stores number of items in the result array (if not NULL)

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTModalityLUTSequence::Item::getLUTDescriptor	(	Uint16 &	value,
		const unsigned long	pos = 0
	)		const

get LUTDescriptor (0028,3002)

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

OFCondition DRTModalityLUTSequence::Item::getLUTExplanation	(	OFString &	value,
		const signed long	pos = 0
	)		const

get LUTExplanation (0028,3003)

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 DRTModalityLUTSequence::Item::getModalityLUTType	(	OFString &	value,
		const signed long	pos = 0
	)		const

get ModalityLUTType (0028,3004)

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

OFBool DRTModalityLUTSequence::Item::isEmpty

(

)

check if item is empty

Returns:

OFTrue if item is empty, OFFalse otherwise

OFBool DRTModalityLUTSequence::Item::isValid

(

)

const

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

Returns:

OFTrue if item is valid, OFFalse otherwise

Item& DRTModalityLUTSequence::Item::operator=

(

const Item &

copy

)

assigment operator

Parameters:

copy	item object to be copied

OFCondition DRTModalityLUTSequence::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 DRTModalityLUTSequence::Item::setLUTData	(	const Uint16 *	value,
		const unsigned long	count
	)

set LUTData (0028,3006)

Parameters:

value	array value to be set (data is copied)
count	number of items in the array

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTModalityLUTSequence::Item::setLUTDescriptor	(	const Uint16	value,
		const unsigned long	pos = 0
	)

set LUTDescriptor (0028,3002)

Parameters:

value	value to be set (should be valid for this VR)
pos	index of the value to be set (0..vm-1), vm=3

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTModalityLUTSequence::Item::setLUTExplanation	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set LUTExplanation (0028,3003)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTModalityLUTSequence::Item::setModalityLUTType	(	const OFString &	value,
		const OFBool	check = OFTrue
	)

set ModalityLUTType (0028,3004)

Parameters:

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

Returns:

status, EC_Normal if successful, an error code otherwise

OFCondition DRTModalityLUTSequence::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/drtmls.h