Inheritance diagram for DRTRecordedBlockSequence::Item:

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	getAccessoryCode (OFString &value, const signed long pos=0) const
	get AccessoryCode (300a,00f9)
OFCondition	getBlockName (OFString &value, const signed long pos=0) const
	get BlockName (300a,00fe)
OFCondition	getBlockTrayID (OFString &value, const signed long pos=0) const
	get BlockTrayID (300a,00f5)
OFCondition	getReferencedBlockNumber (OFString &value, const signed long pos=0) const
	get ReferencedBlockNumber (300c,00e0)
OFCondition	getReferencedBlockNumber (Sint32 &value, const unsigned long pos=0) const
	get ReferencedBlockNumber (300c,00e0)
OFCondition	setAccessoryCode (const OFString &value, const OFBool check=OFTrue)
	set AccessoryCode (300a,00f9)
OFCondition	setBlockName (const OFString &value, const OFBool check=OFTrue)
	set BlockName (300a,00fe)
OFCondition	setBlockTrayID (const OFString &value, const OFBool check=OFTrue)
	set BlockTrayID (300a,00f5)
OFCondition	setReferencedBlockNumber (const OFString &value, const OFBool check=OFTrue)
	set ReferencedBlockNumber (300c,00e0)
Private Attributes
OFBool	EmptyDefaultItem
	internal flag used to mark the empty default item
DcmLongString	AccessoryCode
	AccessoryCode (300a,00f9) vr=LO, vm=1, type=3.
DcmLongString	BlockName
	BlockName (300a,00fe) vr=LO, vm=1, type=3.
DcmShortString	BlockTrayID
	BlockTrayID (300a,00f5) vr=SH, vm=1, type=3.
DcmIntegerString	ReferencedBlockNumber
	ReferencedBlockNumber (300c,00e0) vr=IS, vm=1, type=1.

Detailed Description

Item class.

Constructor & Destructor Documentation

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

(default) constructor

Parameters:

emptyDefaultItem flag used to mark the empty default item

DRTRecordedBlockSequence::Item::Item ( const Item & copy )

copy constructor

Parameters:

copy	item object to be copied

Member Function Documentation

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

get AccessoryCode (300a,00f9)

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

get BlockName (300a,00fe)

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

get BlockTrayID (300a,00f5)

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

get ReferencedBlockNumber (300c,00e0)

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 DRTRecordedBlockSequence::Item::getReferencedBlockNumber	(	Sint32 &	value,
		const unsigned long	pos = `0`
	)		const

get ReferencedBlockNumber (300c,00e0)

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

OFBool DRTRecordedBlockSequence::Item::isEmpty ( )

check if item is empty

Returns:: OFTrue if item is empty, OFFalse otherwise

OFBool DRTRecordedBlockSequence::Item::isValid ( ) const

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

Returns:: OFTrue if item is valid, OFFalse otherwise

Item& DRTRecordedBlockSequence::Item::operator= ( const Item & copy )

assigment operator

Parameters:

copy	item object to be copied

OFCondition DRTRecordedBlockSequence::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 DRTRecordedBlockSequence::Item::setAccessoryCode	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set AccessoryCode (300a,00f9)

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 DRTRecordedBlockSequence::Item::setBlockName	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set BlockName (300a,00fe)

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 DRTRecordedBlockSequence::Item::setBlockTrayID	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set BlockTrayID (300a,00f5)

Parameters:

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

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

OFCondition DRTRecordedBlockSequence::Item::setReferencedBlockNumber	(	const OFString &	value,
		const OFBool	check = `OFTrue`
	)

set ReferencedBlockNumber (300c,00e0)

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

OFCondition DRTRecordedBlockSequence::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/drtrbls.h

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation