DcmItem Class Reference

a class representing a list of DICOM elements in which each element has a different tag and elements are maintained in increasing order of tags. More...

Inheritance diagram for DcmItem:

List of all members.


Public Member Functions
	DcmItem ()
	default constructor
	DcmItem (const DcmTag &tag, const Uint32 len=0)
	constructor.
	DcmItem (const DcmItem &old)
	copy constructor
DcmItem &	operator= (const DcmItem &obj)
	assignment operator.
virtual	~DcmItem ()
	destructor
virtual DcmObject *	clone () const
	clone method
virtual OFCondition	copyFrom (const DcmObject &rhs)
	Virtual object copying.
virtual DcmEVR	ident () const
	get type identifier
virtual unsigned long	getVM ()
	get value multiplicity
virtual unsigned long	card () const
	get cardinality of this item
virtual OFBool	isLeaf () const
	check if this element is a leaf node in a dataset tree.
virtual void	print (STD_NAMESPACE ostream &out, const size_t flags=0, const int level=0, const char pixelFileName=NULL, size_t pixelCounter=NULL)
	print all elements of the item to a stream
virtual Uint32	calcElementLength (const E_TransferSyntax xfer, const E_EncodingType enctype)
	calculate the length of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences.
virtual Uint32	getLength (const E_TransferSyntax xfer=EXS_LittleEndianImplicit, const E_EncodingType enctype=EET_UndefinedLength)
	calculate the value length (without attribute tag, VR and length field) of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences.
virtual void	transferInit ()
	initialize the transfer state of this object.
virtual void	transferEnd ()
	finalize the transfer state of this object.
virtual OFBool	canWriteXfer (const E_TransferSyntax newXfer, const E_TransferSyntax oldXfer)
	check if this DICOM object can be encoded in the given transfer syntax.
virtual OFCondition	read (DcmInputStream &inStream, const E_TransferSyntax ixfer, const E_GrpLenEncoding glenc=EGL_noChange, const Uint32 maxReadLength=DCM_MaxReadLength)
	This function reads the information of all attributes which are captured in the input stream and captures this information in elementList.
virtual OFCondition	write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
	write object to a stream
virtual OFCondition	writeXML (STD_NAMESPACE ostream &out, const size_t flags=0)
	write object in XML format
virtual OFCondition	writeSignatureFormat (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
	special write method for creation of digital signatures
virtual OFBool	containsUnknownVR () const
	returns true if the object contains an element with Unknown VR at any nesting level
virtual OFBool	containsExtendedCharacters (const OFBool checkAllStrings=OFFalse)
	check if this object contains non-ASCII characters at any nesting level
virtual OFBool	isAffectedBySpecificCharacterSet () const
	check if this object is affected by SpecificCharacterSet at any nesting level.
virtual OFCondition	insert (DcmElement *elem, OFBool replaceOld=OFFalse, OFBool checkInsertOrder=OFFalse)
	insert a new element into the list of elements maintained by this item.
virtual DcmElement *	getElement (const unsigned long num)
	access an element from the item.
virtual OFCondition	nextObject (DcmStack &stack, const OFBool intoSub)
	this method enables a stack based, depth-first traversal of a complete hierarchical DICOM dataset (that is, classes derived from DcmItem or DcmSequenceOfItems).
virtual DcmObject *	nextInContainer (const DcmObject *obj)
	this method is only used in container classes, that is, DcmItem and DcmSequenceOfItems.
virtual DcmElement *	remove (const unsigned long num)
	remove element from list.
virtual DcmElement *	remove (DcmObject *elem)
	remove element from list.
virtual DcmElement *	remove (const DcmTagKey &tag)
	remove element from list.
virtual OFBool	isEmpty (const OFBool normalize=OFTrue)
	check if this item is empty
virtual OFCondition	clear ()
	clear (remove) attribute value
virtual OFCondition	verify (const OFBool autocorrect=OFFalse)
	check the currently stored element value
virtual OFCondition	search (const DcmTagKey &xtag, DcmStack &resultStack, E_SearchMode mode=ESM_fromHere, OFBool searchIntoSub=OFTrue)
	a complex, stack-based, hierarchical search method.
virtual OFCondition	loadAllDataIntoMemory ()
	this method loads all attribute values maintained by this object and all sub-objects (in case of a container such as DcmDataset) into memory.
virtual OFCondition	computeGroupLengthAndPadding (const E_GrpLenEncoding glenc, const E_PaddingEncoding padenc=EPD_noChange, const E_TransferSyntax xfer=EXS_Unknown, const E_EncodingType enctype=EET_ExplicitLength, const Uint32 padlen=0, const Uint32 subPadlen=0, Uint32 instanceLength=0)
	This function takes care of group length and padding elements in the current element list according to what is specified in glenc and padenc.
OFBool	tagExists (const DcmTagKey &key, OFBool searchIntoSub=OFFalse)
	check if an element with the given attribute tag exists in the dataset
OFBool	tagExistsWithValue (const DcmTagKey &key, OFBool searchIntoSub=OFFalse)
	check if an element with the given attribute tag exists in the dataset and has a non-empty value (i.e., length > 0)
OFCondition	findAndGetElement (const DcmTagKey &tagKey, DcmElement *&element, const OFBool searchIntoSub=OFFalse, const OFBool createCopy=OFFalse)
	find element and get a pointer to it (or copy it).
OFCondition	findAndGetElements (const DcmTagKey &tagKey, DcmStack &resultStack)
	find all elements matching a particular tag and return references to them on a stack.
OFCondition	findAndGetString (const DcmTagKey &tagKey, const char *&value, const OFBool searchIntoSub=OFFalse)
	find element and get value as a reference to a C string.
OFCondition	findAndGetOFString (const DcmTagKey &tagKey, OFString &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
	find element and get value as a C++ string (only one component).
OFCondition	findAndGetOFStringArray (const DcmTagKey &tagKey, OFString &value, const OFBool searchIntoSub=OFFalse)
	find element and get value as a C++ string (all components).
OFCondition	findAndGetUint8 (const DcmTagKey &tagKey, Uint8 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
	find element and get value as an unsigned 8-bit integer.
OFCondition	findAndGetUint8Array (const DcmTagKey &tagKey, const Uint8 &value, unsigned long count=NULL, const OFBool searchIntoSub=OFFalse)
	find element and get value as an array of unsigned 8-bit integers.
OFCondition	findAndGetUint16 (const DcmTagKey &tagKey, Uint16 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
	find element and get value as an unsigned 16-bit integer.
OFCondition	findAndGetUint16Array (const DcmTagKey &tagKey, const Uint16 &value, unsigned long count=NULL, const OFBool searchIntoSub=OFFalse)
	find element and get value as an array of unsigned 16-bit integers.
OFCondition	findAndGetSint16 (const DcmTagKey &tagKey, Sint16 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
	find element and get value as a signed 16-bit integer.
OFCondition	findAndGetSint16Array (const DcmTagKey &tagKey, const Sint16 &value, unsigned long count=NULL, const OFBool searchIntoSub=OFFalse)
	find element and get value as an array of signed 16-bit integers.
OFCondition	findAndGetUint32 (const DcmTagKey &tagKey, Uint32 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
	find element and get value as an unsigned 32-bit integer.
OFCondition	findAndGetUint32Array (const DcmTagKey &tagKey, const Uint32 &value, unsigned long count=NULL, const OFBool searchIntoSub=OFFalse)
	find element and get value as an array of unsigned 32-bit integers.
OFCondition	findAndGetSint32 (const DcmTagKey &tagKey, Sint32 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
	find element and get value as a signed 32-bit integer.
OFCondition	findAndGetSint32Array (const DcmTagKey &tagKey, const Sint32 &value, unsigned long count=NULL, const OFBool searchIntoSub=OFFalse)
	find element and get value as an array of signed 32-bit integers.
OFCondition	findAndGetLongInt (const DcmTagKey &tagKey, long int &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
	find element and get value as a (signed) long integer.
OFCondition	findAndGetFloat32 (const DcmTagKey &tagKey, Float32 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
	find element and get value as a 32-bit floating point.
OFCondition	findAndGetFloat32Array (const DcmTagKey &tagKey, const Float32 &value, unsigned long count=NULL, const OFBool searchIntoSub=OFFalse)
	find element and get value as an array of 32-bit floating point values.
OFCondition	findAndGetFloat64 (const DcmTagKey &tagKey, Float64 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
	find element and get value as a 64-bit floating point.
OFCondition	findAndGetFloat64Array (const DcmTagKey &tagKey, const Float64 &value, unsigned long count=NULL, const OFBool searchIntoSub=OFFalse)
	find element and get value as an array of 64-bit floating point values.
OFCondition	findAndGetSequence (const DcmTagKey &seqTagKey, DcmSequenceOfItems *&sequence, const OFBool searchIntoSub=OFFalse, const OFBool createCopy=OFFalse)
	looks up and returns a given sequence.
OFCondition	findAndGetSequenceItem (const DcmTagKey &seqTagKey, DcmItem *&item, const signed long itemNum=0, const OFBool createCopy=OFFalse)
	looks up and returns a given sequence item, if it exists.
OFCondition	findOrCreateSequenceItem (const DcmTag &seqTag, DcmItem *&item, const signed long itemNum=0)
	looks up the given sequence in the current dataset and returns the given item.
OFCondition	findAndInsertCopyOfElement (const DcmTagKey &tagKey, DcmItem *destItem, const OFBool replaceOld=OFTrue)
	find element, create a copy and insert it into the given destination dataset.
OFCondition	findAndDeleteElement (const DcmTagKey &tagKey, const OFBool allOccurrences=OFFalse, const OFBool searchIntoSub=OFFalse)
	find element, remove it from the dataset and free the associated memory.
OFCondition	findAndDeleteSequenceItem (const DcmTagKey &seqTagKey, const signed long itemNum)
	looks up the given sequence in the current dataset and deletes the given item.
OFCondition	putAndInsertString (const DcmTag &tag, const char *value, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	putAndInsertOFStringArray (const DcmTag &tag, const OFString &value, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	putAndInsertUint8Array (const DcmTag &tag, const Uint8 *value, const unsigned long count, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	putAndInsertUint16 (const DcmTag &tag, const Uint16 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	putAndInsertUint16Array (const DcmTag &tag, const Uint16 *value, const unsigned long count, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	putAndInsertSint16 (const DcmTag &tag, const Sint16 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	putAndInsertSint16Array (const DcmTag &tag, const Sint16 *value, const unsigned long count, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	putAndInsertUint32 (const DcmTag &tag, const Uint32 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	putAndInsertSint32 (const DcmTag &tag, const Sint32 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	putAndInsertFloat32 (const DcmTag &tag, const Float32 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	putAndInsertFloat64 (const DcmTag &tag, const Float64 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
	create a new element, put specified value to it and insert the element into the dataset/item.
OFCondition	insertEmptyElement (const DcmTag &tag, const OFBool replaceOld=OFTrue)
	create a new element (with no value) and insert it into the dataset/item.
OFCondition	insertSequenceItem (const DcmTag &seqTag, DcmItem *item, const signed long itemNum=-2)
	looks up the given sequence in the current dataset and inserts the given item.
Protected Member Functions
OFCondition	readTagAndLength (DcmInputStream &inStream, const E_TransferSyntax xfer, DcmTag &tag, Uint32 &length, Uint32 &bytesRead)
	This function reads tag and length information from inStream and returns this information to the caller.
OFCondition	readSubElement (DcmInputStream &inStream, DcmTag &newTag, const Uint32 newLength, const E_TransferSyntax xfer, const E_GrpLenEncoding glenc, const Uint32 maxReadLength=DCM_MaxReadLength)
	This function creates a new DcmElement object on the basis of the newTag and newLength information which was passed, inserts this new element into elementList, reads the actual data value which belongs to this element (attribute) from the inStream and also assigns this information to the object which was created at the beginning.
E_TransferSyntax	checkTransferSyntax (DcmInputStream &inStream)
	This function reads the first 6 bytes from the input stream and determines the transfer syntax which was used to code the information in the stream.
void	checkAndUpdateVR (DcmItem &item, DcmTag &tag)
	check whether the given tag requires some special handling regarding the VR (i.e.
Protected Attributes
DcmList *	elementList
	the list of elements maintained by this object
OFBool	lastElementComplete
	flag used during suspended I/O.
offile_off_t	fStartPosition
	used during reading.
Private Member Functions
OFCondition	searchSubFromHere (const DcmTagKey &tag, DcmStack &resultStack, OFBool searchIntoSub)
	helper function for search().
Static Private Member Functions
static OFBool	foundVR (const Uint8 *atposition)
	helper function that interprets the given pointer as a pointer to an array of two characters and checks whether these two characters form a valid standard DICOM VR.
Private Attributes
DcmPrivateTagCache	privateCreatorCache
	cache for private creator tags and names

Detailed Description

a class representing a list of DICOM elements in which each element has a different tag and elements are maintained in increasing order of tags.

In particular, a sequence item.

Definition at line 51 of file dcitem.h.

Constructor & Destructor Documentation

DcmItem::DcmItem	(	const DcmTag &	tag,
		const Uint32	len = `0`
	)

constructor.

Create new item from given tag and length.

Parameters:

	tag	DICOM tag for the new element
	len	value length for the new element

DcmItem::DcmItem ( const DcmItem & old )

copy constructor

Parameters:

old

item to be copied

Member Function Documentation

DcmItem& DcmItem::operator= ( const DcmItem & obj )

assignment operator.

Private creator cache is not copied as it is also the case for clone().

Parameters:

the

item to be copied

virtual DcmObject* DcmItem::clone ( ) const [inline, virtual]

clone method

Returns:: deep copy of this object

Implements DcmObject.

Reimplemented in DcmDataset, DcmDirectoryRecord, and DcmMetaInfo.

Definition at line 86 of file dcitem.h.

References DcmItem().

virtual OFCondition DcmItem::copyFrom ( const DcmObject & rhs ) [virtual]

Virtual object copying.

This method can be used for DcmObject and derived classes to get a deep copy of an object. Internally the assignment operator is called if the given DcmObject parameter is of the same type as "this" object instance. If not, an error is returned. This function permits copying an object by value in a virtual way which therefore is different to just calling the assignment operator of DcmElement which could result in slicing the object.

Parameters:

rhs

- [in] The instance to copy from. Has to be of the same class type as "this" object

Returns:: EC_Normal if copying was successful, error otherwise

Implements DcmObject.

Reimplemented in DcmDataset, DcmDirectoryRecord, and DcmMetaInfo.

virtual DcmEVR DcmItem::ident ( ) const [virtual]

get type identifier

Returns:: type identifier of this class (EVR_item)

Implements DcmObject.

Reimplemented in DcmDataset, DcmDirectoryRecord, and DcmMetaInfo.

virtual unsigned long DcmItem::getVM ( ) [virtual]

get value multiplicity

Returns:: always returns 1 (according to the DICOM standard)

Implements DcmObject.

virtual unsigned long DcmItem::card ( ) const [virtual]

get cardinality of this item

Returns:: number of elements in this item

virtual OFBool DcmItem::isLeaf ( ) const [inline, virtual]

check if this element is a leaf node in a dataset tree.

All subclasses of DcmElement except for DcmSequenceOfItems are leaf nodes, while DcmSequenceOfItems, DcmItem, DcmDataset etc. are not.

Returns:: true if leaf node, false otherwise.

Implements DcmObject.

Definition at line 126 of file dcitem.h.

virtual void DcmItem::print	(	STD_NAMESPACE ostream &	out,
		const size_t	flags = `0`,
		const int	level = `0`,
		const char *	pixelFileName = `NULL`,
		size_t *	pixelCounter = `NULL`
	)			`[virtual]`

print all elements of the item to a stream

Parameters:

	out	output stream
	flags	optional flag used to customize the output (see DCMTypes::PF_xxx)
	level	current level of nested items. Used for indentation.
	pixelFileName	not used
	pixelCounter	not used

Implements DcmObject.

Reimplemented in DcmDataset, DcmDirectoryRecord, and DcmMetaInfo.

virtual Uint32 DcmItem::calcElementLength	(	const E_TransferSyntax	xfer,
		const E_EncodingType	enctype
	)			`[virtual]`

calculate the length of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences.

For elements, the length includes the length of the tag, length field, VR field and the value itself, for items and sequences it returns the length of the complete item or sequence including delimitation tags if applicable. If length encodig is set to be explicit and the total item size is larger than the available 32-bit length field, then undefined length is returned. If "dcmWriteOversizedSeqsAndItemsImplicit" is disabled, also the internal DcmObject errorFlag is set to EC_SeqOrItemContentOverflow in case the item content (excluding tag header etc.) is already too large.

Parameters:

	xfer	transfer syntax for length calculation
	enctype	sequence encoding type for length calculation

Returns:: length of DICOM element

Implements DcmObject.

Reimplemented in DcmDataset, and DcmMetaInfo.

virtual Uint32 DcmItem::getLength	(	const E_TransferSyntax	xfer = `EXS_LittleEndianImplicit`,
		const E_EncodingType	enctype = `EET_UndefinedLength`
	)			`[virtual]`

calculate the value length (without attribute tag, VR and length field) of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences.

If length encodig is set to be explicit and the item content is larger than the available 32-bit length field, then undefined length is returned. If "dcmWriteOversizedSeqsAndItemsUndefined" is disabled, also the internal DcmObject errorFlag is set to EC_SeqOrItemContentOverflow.

Parameters:

	xfer	transfer syntax for length calculation
	enctype	sequence encoding type for length calculation

Returns:: value length of DICOM element

Implements DcmObject.

virtual void DcmItem::transferInit ( ) [virtual]

initialize the transfer state of this object.

This method must be called before this object is written to a stream or read (parsed) from a stream.

Reimplemented from DcmObject.

Reimplemented in DcmMetaInfo.

virtual void DcmItem::transferEnd ( ) [virtual]

finalize the transfer state of this object.

This method must be called when reading/writing this object from/to a stream has been completed.

Reimplemented from DcmObject.

Reimplemented in DcmMetaInfo.

virtual OFBool DcmItem::canWriteXfer	(	const E_TransferSyntax	newXfer,
		const E_TransferSyntax	oldXfer
	)			`[virtual]`

check if this DICOM object can be encoded in the given transfer syntax.

Parameters:

	newXfer	transfer syntax in which the DICOM object is to be encoded
	oldXfer	transfer syntax in which the DICOM object was read or created.

Returns:: true if object can be encoded in desired transfer syntax, false otherwise.

Implements DcmObject.

Reimplemented in DcmDataset.

virtual OFCondition DcmItem::read	(	DcmInputStream &	inStream,
		const E_TransferSyntax	ixfer,
		const E_GrpLenEncoding	glenc = `EGL_noChange`,
		const Uint32	maxReadLength = `DCM_MaxReadLength`
	)			`[virtual]`

This function reads the information of all attributes which are captured in the input stream and captures this information in elementList.

Each attribute is represented as an element in this list. If not all information for an attribute could be read from the stream, the function returns EC_StreamNotifyClient.

Parameters:

	inStream	The stream which contains the information.
	ixfer	The transfer syntax which was used to encode the information in inStream.
	glenc	Encoding type for group length; specifies what will be done with group length tags.
	maxReadLength	Maximum read length for reading an attribute value.

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

Implements DcmObject.

Reimplemented in DcmDataset, DcmDirectoryRecord, and DcmMetaInfo.

virtual OFCondition DcmItem::write	(	DcmOutputStream &	outStream,
		const E_TransferSyntax	oxfer,
		const E_EncodingType	enctype,
		DcmWriteCache *	wcache
	)			`[virtual]`

write object to a stream

Parameters:

	outStream	DICOM output stream
	oxfer	output transfer syntax
	enctype	encoding types (undefined or explicit length)
	wcache	pointer to write cache object, may be NULL

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

Implements DcmObject.

Reimplemented in DcmDataset, and DcmMetaInfo.

virtual OFCondition DcmItem::writeXML	(	STD_NAMESPACE ostream &	out,
		const size_t	flags = `0`
	)			`[virtual]`

write object in XML format

Parameters:

	out	output stream to which the XML document is written
	flags	optional flag used to customize the output (see DCMTypes::XF_xxx)

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

Reimplemented from DcmObject.

Reimplemented in DcmDataset, DcmDirectoryRecord, and DcmMetaInfo.

virtual OFCondition DcmItem::writeSignatureFormat	(	DcmOutputStream &	outStream,
		const E_TransferSyntax	oxfer,
		const E_EncodingType	enctype,
		DcmWriteCache *	wcache
	)			`[virtual]`

special write method for creation of digital signatures

Parameters:

	outStream	DICOM output stream
	oxfer	output transfer syntax
	enctype	encoding types (undefined or explicit length)
	wcache	pointer to write cache object, may be NULL

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

Implements DcmObject.

Reimplemented in DcmDataset.

virtual OFBool DcmItem::containsUnknownVR ( ) const [virtual]

returns true if the object contains an element with Unknown VR at any nesting level

Returns:: true if the object contains an element with Unknown VR, false otherwise

Reimplemented from DcmObject.

virtual OFBool DcmItem::containsExtendedCharacters ( const OFBool checkAllStrings = OFFalse ) [virtual]

check if this object contains non-ASCII characters at any nesting level

Parameters:

checkAllStrings

if true, also check elements with string values not affected by SpecificCharacterSet (0008,0005), default: only check PN, LO, LT, SH, ST, UT

Returns:: true if object contains non-ASCII characters, false otherwise

Reimplemented from DcmObject.

virtual OFBool DcmItem::isAffectedBySpecificCharacterSet ( ) const [virtual]

check if this object is affected by SpecificCharacterSet at any nesting level.

In detail, it is checked whether this object contains any data elements that according to their VR are affected by the SpecificCharacterSet (0008,0005) element. This is true for the following VRs: PN, LO, LT, SH, ST and UT

Returns:: true if object is affected by SpecificCharacterSet, false otherwise

Reimplemented from DcmObject.

virtual OFCondition DcmItem::insert	(	DcmElement *	elem,
		OFBool	replaceOld = `OFFalse`,
		OFBool	checkInsertOrder = `OFFalse`
	)			`[virtual]`

insert a new element into the list of elements maintained by this item.

The list of elements is always kept in ascending tag order.

Parameters:

	elem	element to be inserted, must not be contained in this or any other item. Will be deleted upon destruction of this item object.
	replaceOld	if true, this element replaces any other element with the same tag which may already be contained in the item. If false, insert fails if another element with the same tag is already present.
	checkInsertOrder	if true, a warning message is sent to the console if the element is not inserted at the end of the list. This is used in the read() method to detect datasets with out-of-order elements.

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

Referenced by I2DOutputPlug::checkAndInventType1Attrib(), and I2DOutputPlug::checkAndInventType2Attrib().

virtual DcmElement* DcmItem::getElement ( const unsigned long num ) [virtual]

access an element from the item.

This method returns a pointer to one of the elements in the item, and not a copy.

Parameters:

num

index number of element, must be < card()

Returns:: pointer to element if found, NULL if num >= card()

virtual OFCondition DcmItem::nextObject	(	DcmStack &	stack,
		const OFBool	intoSub
	)			`[virtual]`

this method enables a stack based, depth-first traversal of a complete hierarchical DICOM dataset (that is, classes derived from DcmItem or DcmSequenceOfItems).

With each call of this method, the next object in the tree is located and marked on the stack.

Parameters:

	stack	"cursor" for current position in the dataset. The stack will contain a pointer to each dataset, sequence, item and element from the main dataset down to the current element, and is updated upon each call to this method. An empty stack is equivalent to a stack containing a pointer to this object only.
	intoSub	if true, the nextObject method will perform a hierarchical search through the dataset (depth-first), if false, only the current container object will be traversed (e.g., all elements of an item or all items of a sequence).

Returns:: EC_Normal if value length is correct, an error code otherwise

Reimplemented from DcmObject.

virtual DcmObject* DcmItem::nextInContainer ( const DcmObject * obj ) [virtual]

this method is only used in container classes, that is, DcmItem and DcmSequenceOfItems.

It returns a pointer to the next object in the list AFTER the given object. If the caller passes NULL, a pointer to the first object in the list is returned. If the given object is not found, the given object is the last one in the list or the list is empty, NULL is returned.

Parameters:

obj

pointer to one object in the container; we are looking for the next entry after this one. NULL if looking for the first entry.

Returns:: pointer to next object in container or NULL if not found

Reimplemented from DcmObject.

virtual DcmElement* DcmItem::remove ( const unsigned long num ) [virtual]

remove element from list.

If found, the element is not deleted but returned to the caller who is responsible for further management of the DcmElement object.

Parameters:

num

index number of element, must be < card()

Returns:: pointer to DcmElement if found, NULL otherwise

virtual DcmElement* DcmItem::remove ( DcmObject * elem ) [virtual]

remove element from list.

If found, the element is not deleted but returned to the caller who is responsible for further management of the DcmElement object.

Parameters:

elem

pointer to element (as type DcmObject *) to be removed from list

Returns:: pointer to element (as type DcmElement *) if found, NULL otherwise

virtual DcmElement* DcmItem::remove ( const DcmTagKey & tag ) [virtual]

remove element from list.

If found, the element is not deleted but returned to the caller who is responsible for further management of the DcmElement object.

Parameters:

tag

attribute tag of element to be removed

Returns:: pointer to DcmElement if found, NULL otherwise

virtual OFBool DcmItem::isEmpty ( const OFBool normalize = OFTrue ) [virtual]

check if this item is empty

Parameters:

normalize

not used for this class

Returns:: true if item is empty, i.e. has no elements, false otherwise

Reimplemented from DcmObject.

virtual OFCondition DcmItem::clear ( ) [virtual]

clear (remove) attribute value

Returns:: EC_Normal if successful, an error code otherwise

Implements DcmObject.

Reimplemented in DcmDataset.

virtual OFCondition DcmItem::verify ( const OFBool autocorrect = OFFalse ) [virtual]

check the currently stored element value

Parameters:

autocorrect

correct value length if OFTrue

Returns:: status, EC_Normal if value length is correct, an error code otherwise

Implements DcmObject.

Reimplemented in DcmDirectoryRecord.

virtual OFCondition DcmItem::search	(	const DcmTagKey &	xtag,
		DcmStack &	resultStack,
		E_SearchMode	mode = `ESM_fromHere`,
		OFBool	searchIntoSub = `OFTrue`
	)			`[virtual]`

a complex, stack-based, hierarchical search method.

It allows for a search for a DICOM object with a given attribute within a given container, hierarchically, from a starting position identified through a cursor stack.

Parameters:

	xtag	the DICOM attribute tag we are searching for
	resultStack	Depending on the search mode (see below), this parameter either serves as an input and output parameter, or as an output parameter only (the latter being the default). When used as an input parameter, the cursor stack defines the start position for the search within a hierarchical DICOM dataset. Upon successful return, the stack contains the position of the element found, in the form of a pointer to each dataset, sequence, item and element from the main dataset down to the found element.
	mode	search mode, controls how the search stack is handled. In the default mode, ESM_fromHere, the stack is ignored on input, and the search starts in the object for which this method is called. In the other modes, the stack is used both as an input and an output parameter and defines the starting point for the search.
	searchIntoSub	if true, the search will be performed hierarchically descending into the sequences and items of the dataset. If false, only the current container (sequence or item) will be traversed.

Returns:: EC_Normal if found, EC_TagNotFound if not found, an error code is something went wrong.

Reimplemented from DcmObject.

Reimplemented in DcmDirectoryRecord.

virtual OFCondition DcmItem::loadAllDataIntoMemory ( ) [virtual]

this method loads all attribute values maintained by this object and all sub-objects (in case of a container such as DcmDataset) into memory.

After a call to this method, the file from which a dataset was read may safely be deleted or replaced. For large files, this method may obviously allocate large amounts of memory.

Returns:: EC_Normal if successful, an error code otherwise

Implements DcmObject.

virtual OFCondition DcmItem::computeGroupLengthAndPadding	(	const E_GrpLenEncoding	glenc,
		const E_PaddingEncoding	padenc = `EPD_noChange`,
		const E_TransferSyntax	xfer = `EXS_Unknown`,
		const E_EncodingType	enctype = `EET_ExplicitLength`,
		const Uint32	padlen = `0`,
		const Uint32	subPadlen = `0`,
		Uint32	instanceLength = `0`
	)			`[virtual]`

This function takes care of group length and padding elements in the current element list according to what is specified in glenc and padenc.

If required, this function does the following two things: a) it calculates the group length of all groups which are contained in this item and sets the calculated values in the corresponding group length elements and b) it inserts a corresponding padding element (or, in case of sequences: padding elements) with a corresponding correct size into the element list.

Parameters:

	glenc	Encoding type for group length; specifies what shall be done with group length tags.
	padenc	Encoding type for padding; specifies what shall be done with padding tags.
	xfer	The transfer syntax that shall be used.
	enctype	Encoding type for sequences; specifies how sequences will be handled.
	padlen	The length up to which the dataset shall be padded, if padding is desired.
	subPadlen	For sequences (ie sub elements), the length up to which item shall be padded, if padding is desired.
	instanceLength	Number of extra bytes added to the item/dataset length used when computing the padding; this parameter is for instance used to pass the length of the file meta header from the DcmFileFormat to the DcmDataset object.

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

OFBool DcmItem::tagExists	(	const DcmTagKey &	key,
		OFBool	searchIntoSub = `OFFalse`
	)

check if an element with the given attribute tag exists in the dataset

Parameters:

	key	tag key to be searched
	searchIntoSub	if true, do hierarchical search within sequences, if false only search through this dataset

Returns:: true if tag found, false otherwise

Referenced by I2DOutputPlug::checkAndInventType1Attrib(), and I2DOutputPlug::checkAndInventType2Attrib().

OFBool DcmItem::tagExistsWithValue	(	const DcmTagKey &	key,
		OFBool	searchIntoSub = `OFFalse`
	)

check if an element with the given attribute tag exists in the dataset and has a non-empty value (i.e., length > 0)

Parameters:

	key	tag key to be searched
	searchIntoSub	if true, do hierarchical search within sequences, if false only search through this dataset

Returns:: true if tag found and element non-empty, false otherwise

OFCondition DcmItem::findAndGetElement	(	const DcmTagKey &	tagKey,
		DcmElement *&	element,
		const OFBool	searchIntoSub = `OFFalse`,
		const OFBool	createCopy = `OFFalse`
	)

find element and get a pointer to it (or copy it).

Applicable to all DICOM value representations (VR). The result variable 'element' is automatically set to NULL if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	element	variable in which the reference to (or copy of) the element is stored
	searchIntoSub	flag indicating whether to search into sequences or not
	createCopy	create a copy of the element if true, return a reference otherwise

Returns:: EC_Normal upon success, an error code otherwise.

Referenced by I2DOutputPlug::checkAndInventType1Attrib().

OFCondition DcmItem::findAndGetElements	(	const DcmTagKey &	tagKey,
		DcmStack &	resultStack
	)

find all elements matching a particular tag and return references to them on a stack.

This functions always performs a deep search (i.e. searches into sequence of items).

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	resultStack	stack where references to the elements are stored (added to). If no element is found, the stack is not modified (e.g. cleared).

Returns:: EC_Normal if at least one matching tag is found, an error code otherwise.

OFCondition DcmItem::findAndGetString	(	const DcmTagKey &	tagKey,
		const char *&	value,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as a reference to a C string.

Applicable to the following VRs: AE, AS, CS, DA, DS, DT, IS, LO, LT, PN, SH, ST, TM, UI, UT Since the getString() routine is called internally the resulting string reference represents the (possibly multi-valued) value as stored in the dataset, i.e. no normalization is performed. The result variable 'value' is automatically set to NULL if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the reference to the element value is stored (might be NULL)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetOFString	(	const DcmTagKey &	tagKey,
		OFString &	value,
		const unsigned long	pos = `0`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as a C++ string (only one component).

Applicable to the following VRs: AE, AS, AT, CS, DA, DS, DT, FL, FD, IS, LO, LT, OB, OF, OW, PN, SH, SL, SS, ST, TM, UI, UL, US, UT Since the getOFString() routine is called internally the resulting string is normalized, i.e. leading and/or trailing spaces are removed according to the associated value representation, or the element value is converted to a character string (for non-string VRs) - see documentation in the corresponding header file. In contrast to the above and below function only the specified component (see parameter 'pos') is returned. The result variable 'value' is automatically set to an empty string if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the element value is stored
	pos	index of the value in case of multi-valued elements (0..vm-1)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetOFStringArray	(	const DcmTagKey &	tagKey,
		OFString &	value,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as a C++ string (all components).

Applicable to the following VRs: AE, AS, AT, CS, DA, DS, DT, FL, FD, IS, LO, LT, OB, OF, OW, PN, SH, SL, SS, ST, TM, UI, UL, US, UT Since the getOFStringArray() routine is called internally the resulting string is normalized, i.e. leading and/or trailing spaces are removed according to the associated value representation or the element values are converted to character strings (for non-string VRs) - see documentation in the corresponding header file. The result variable 'value' is automatically set to an empty string if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the element value is stored
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetUint8	(	const DcmTagKey &	tagKey,
		Uint8 &	value,
		const unsigned long	pos = `0`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as an unsigned 8-bit integer.

Applicable to the following VRs: OB The result variable 'value' is automatically set to zero if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the element value is stored
	pos	index of the value in case of multi-valued elements (0..vm-1)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetUint8Array	(	const DcmTagKey &	tagKey,
		const Uint8 *&	value,
		unsigned long *	count = `NULL`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as an array of unsigned 8-bit integers.

Applicable to the following VRs: OB The result variable 'value' is automatically set to NULL if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the reference to the element value is stored
	count	stores number of items in the result array (if not NULL)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetUint16	(	const DcmTagKey &	tagKey,
		Uint16 &	value,
		const unsigned long	pos = `0`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as an unsigned 16-bit integer.

Applicable to the following VRs: OW, US The result variable 'value' is automatically set to zero if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the element value is stored
	pos	index of the value in case of multi-valued elements (0..vm-1)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetUint16Array	(	const DcmTagKey &	tagKey,
		const Uint16 *&	value,
		unsigned long *	count = `NULL`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as an array of unsigned 16-bit integers.

Applicable to the following VRs: AT, OW, US The result variable 'value' is automatically set to NULL if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the reference to the element value is stored
	count	stores number of items in the result array (if not NULL)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetSint16	(	const DcmTagKey &	tagKey,
		Sint16 &	value,
		const unsigned long	pos = `0`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as a signed 16-bit integer.

Applicable to the following VRs: SS The result variable 'value' is automatically set to zero if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the element value is stored
	pos	index of the value in case of multi-valued elements (0..vm-1)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetSint16Array	(	const DcmTagKey &	tagKey,
		const Sint16 *&	value,
		unsigned long *	count = `NULL`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as an array of signed 16-bit integers.

Applicable to the following VRs: SS The result variable 'value' is automatically set to NULL if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the reference to the element value is stored
	count	stores number of items in the result array (if not NULL)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetUint32	(	const DcmTagKey &	tagKey,
		Uint32 &	value,
		const unsigned long	pos = `0`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as an unsigned 32-bit integer.

Applicable to the following VRs: UL The result variable 'value' is automatically set to zero if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the element value is stored
	pos	index of the value in case of multi-valued elements (0..vm-1)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetUint32Array	(	const DcmTagKey &	tagKey,
		const Uint32 *&	value,
		unsigned long *	count = `NULL`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as an array of unsigned 32-bit integers.

Applicable to the following VRs: UL The result variable 'value' is automatically set to NULL if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the reference to the element value is stored
	count	stores number of items in the result array (if not NULL)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetSint32	(	const DcmTagKey &	tagKey,
		Sint32 &	value,
		const unsigned long	pos = `0`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as a signed 32-bit integer.

Applicable to the following VRs: IS, SL The result variable 'value' is automatically set to zero if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the element value is stored
	pos	index of the value in case of multi-valued elements (0..vm-1)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetSint32Array	(	const DcmTagKey &	tagKey,
		const Sint32 *&	value,
		unsigned long *	count = `NULL`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as an array of signed 32-bit integers.

Applicable to the following VRs: SL The result variable 'value' is automatically set to NULL if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the reference to the element value is stored
	count	stores number of items in the result array (if not NULL)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetLongInt	(	const DcmTagKey &	tagKey,
		long int &	value,
		const unsigned long	pos = `0`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as a (signed) long integer.

Applicable to the following VRs: IS, SL, SS, UL, US The result variable 'value' is automatically set to zero if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the element value is stored
	pos	index of the value in case of multi-valued elements (0..vm-1)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetFloat32	(	const DcmTagKey &	tagKey,
		Float32 &	value,
		const unsigned long	pos = `0`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as a 32-bit floating point.

Applicable to the following VRs: FL, OF The result variable 'value' is automatically set to zero if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the element value is stored
	pos	index of the value in case of multi-valued elements (0..vm-1)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetFloat32Array	(	const DcmTagKey &	tagKey,
		const Float32 *&	value,
		unsigned long *	count = `NULL`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as an array of 32-bit floating point values.

Applicable to the following VRs: FL, OF The result variable 'value' is automatically set to NULL if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the reference to the element value is stored
	count	stores number of items in the result array (if not NULL)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetFloat64	(	const DcmTagKey &	tagKey,
		Float64 &	value,
		const unsigned long	pos = `0`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as a 64-bit floating point.

Applicable to the following VRs: DS, FD The result variable 'value' is automatically set to zero if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the element value is stored
	pos	index of the value in case of multi-valued elements (0..vm-1)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetFloat64Array	(	const DcmTagKey &	tagKey,
		const Float64 *&	value,
		unsigned long *	count = `NULL`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element and get value as an array of 64-bit floating point values.

Applicable to the following VRs: FD The result variable 'value' is automatically set to NULL if an error occurs.

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	value	variable in which the reference to the element value is stored
	count	stores number of items in the result array (if not NULL)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndGetSequence	(	const DcmTagKey &	seqTagKey,
		DcmSequenceOfItems *&	sequence,
		const OFBool	searchIntoSub = `OFFalse`,
		const OFBool	createCopy = `OFFalse`
	)

looks up and returns a given sequence.

Applicable to the following VRs: SQ, (pixelSQ) The result variable 'sequence' is automatically set to NULL if an error occurs (e.g. if 'seqTagKey' does not refer to a sequence attribute).

Parameters:

	seqTagKey	DICOM tag specifying the sequence attribute to be searched for
	sequence	variable in which the reference to (or copy of) the sequence is stored
	searchIntoSub	flag indicating whether to search into sub-sequences or not
	createCopy	create a copy of the sequence if true, return a reference otherwise

Returns:: EC_Normal upon success, an error otherwise.

OFCondition DcmItem::findAndGetSequenceItem	(	const DcmTagKey &	seqTagKey,
		DcmItem *&	item,
		const signed long	itemNum = `0`,
		const OFBool	createCopy = `OFFalse`
	)

looks up and returns a given sequence item, if it exists.

Otherwise sets 'item' to NULL and returns EC_TagNotFound (specified sequence does not exist) or EC_IllegalParameter (specified item does not exist). Only the top-most level of the dataset/item is examined (i.e. no deep-search is performed). Applicable to the following VRs: SQ, (pixelSQ)

Parameters:

	seqTagKey	DICOM tag specifying the sequence attribute to be searched for
	item	variable in which the reference to (or copy of) the item is stored
	itemNum	number of the item to be searched for (0..n-1, -1 for last)
	createCopy	create a copy of the item if true, return a reference otherwise

Returns:: EC_Normal upon success, an error otherwise.

OFCondition DcmItem::findOrCreateSequenceItem	(	const DcmTag &	seqTag,
		DcmItem *&	item,
		const signed long	itemNum = `0`
	)

looks up the given sequence in the current dataset and returns the given item.

If either the sequence or the item do not exist, they are created. If necessary, multiple empty items are inserted. Only the top-most level of the dataset/item is examined (i.e. no deep-search is performed). Applicable to the following VRs: SQ, (pixelSQ)

Parameters:

	seqTag	DICOM tag specifying the sequence attribute to be searched for (or to be created)
	item	variable in which the reference to the sequence item is stored
	itemNum	number of the item to be searched for (0..n-1, -1 for last, -2 for append new)

Returns:: EC_Normal upon success, an error otherwise.

OFCondition DcmItem::findAndInsertCopyOfElement	(	const DcmTagKey &	tagKey,
		DcmItem *	destItem,
		const OFBool	replaceOld = `OFTrue`
	)

find element, create a copy and insert it into the given destination dataset.

This functions never performs a deep search (i.e. does not search into sequence of items). Empty elements are also copied. However, if the given tag is not found in the current dataset, EC_TagNotFound is returned and the destination dataset remains unchanged. Applicable to all DICOM value representations (VR).

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	destItem	destination dataset to which the copied element is inserted
	replaceOld	flag indicating whether to replace an existing element or not

Returns:: EC_Normal upon success, an error code otherwise

OFCondition DcmItem::findAndDeleteElement	(	const DcmTagKey &	tagKey,
		const OFBool	allOccurrences = `OFFalse`,
		const OFBool	searchIntoSub = `OFFalse`
	)

find element, remove it from the dataset and free the associated memory.

Applicable to all DICOM value representations (VR).

Parameters:

	tagKey	DICOM tag specifying the attribute to be searched for
	allOccurrences	flag indicating whether to delete all occurrences of the attribute tag or the first one only (implies 'searchIntoSub' to be true)
	searchIntoSub	flag indicating whether to search into sequences or not

Returns:: EC_Normal upon success, an error code otherwise.

OFCondition DcmItem::findAndDeleteSequenceItem	(	const DcmTagKey &	seqTagKey,
		const signed long	itemNum
	)

looks up the given sequence in the current dataset and deletes the given item.

Applicable to the following VRs: SQ, (pixelSQ)

Parameters:

	seqTagKey	DICOM tag specifying the sequence attribute to be searched for
	itemNum	number of the item to be deleted (0..n-1, -1 for last)

Returns:: EC_Normal upon success, an error otherwise.

OFCondition DcmItem::putAndInsertString	(	const DcmTag &	tag,
		const char *	value,
		const OFBool	replaceOld = `OFTrue`
	)