DcmAttributeTag Class Reference

a class representing the DICOM value representation 'Attribute Tag' (AT) More...

Inheritance diagram for DcmAttributeTag:


Public Member Functions
	DcmAttributeTag (const DcmTag &tag, const Uint32 len=0)
	constructor.
	DcmAttributeTag (const DcmAttributeTag &old)
	copy constructor
virtual	~DcmAttributeTag ()
	destructor
DcmAttributeTag &	operator= (const DcmAttributeTag &obj)
	assignment operator
virtual DcmObject *	clone () const
	clone method
virtual DcmEVR	ident () const
	get element type identifier
virtual unsigned long	getVM ()
	get value multiplicity
virtual void	print (ostream &out, const size_t flags=0, const int level=0, const char pixelFileName=NULL, size_t pixelCounter=NULL)
	print element to a stream.
virtual OFCondition	getTagVal (DcmTagKey &tagVal, const unsigned long pos=0)
	get particular tag value
virtual OFCondition	getUint16Array (Uint16 *&uintVals)
	get reference to stored integer data.
virtual OFCondition	getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
	get specified value as a character string.
virtual OFCondition	putTagVal (const DcmTagKey &tagVal, const unsigned long pos=0)
	set particular tag value
virtual OFCondition	putUint16Array (const Uint16 *uintVals, const unsigned long numUints)
	set element value to given integer array data.
virtual OFCondition	putString (const char *stringVal)
	set element value from the given character string.
virtual OFCondition	verify (const OFBool autocorrect=OFFalse)
	check the currently stored element value

Detailed Description

a class representing the DICOM value representation 'Attribute Tag' (AT)

Definition at line 45 of file dcvrat.h.

Constructor & Destructor Documentation

DcmAttributeTag::DcmAttributeTag ( const DcmTag & tag,

const Uint32 len = 0

)

constructor.
Create new element from given tag and length.
Parameters:

tag DICOM tag for the new element

len value length for the new element

Referenced by clone().

DcmAttributeTag::DcmAttributeTag ( const DcmAttributeTag & old )

copy constructor

Parameters:

old element to be copied

Member Function Documentation

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

clone method

Returns:
deep copy of this object

Implements DcmObject.
Definition at line 77 of file dcvrat.h.
References DcmAttributeTag().

virtual OFCondition DcmAttributeTag::getOFString ( OFString & stringVal,

const unsigned long pos,

OFBool normalize = OFTrue

) [virtual]

get specified value as a character string.
The output format is "(gggg,eeee)" where "gggg" is the hexa-decimal group number and "eeee" the hexa-decimal element number of the attribute tag.
Parameters:

stringVal variable in which the result value is stored

pos index of the value in case of multi-valued elements (0..vm-1)

normalize not used

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

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::getTagVal ( DcmTagKey & tagVal,

const unsigned long pos = 0

) [virtual]

get particular tag value

Parameters:

tagVal reference to result variable (cleared in case of error)

pos index of the value to be retrieved (0..vm-1)

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

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::getUint16Array ( Uint16 *& uintVals ) [virtual]

get reference to stored integer data.
The array entries with an even-numbered index contain the group numbers and the odd entries contain the element numbers (see "putUint16Array()"). The number of entries is twice as large as the return value of "getVM()".
Parameters:

uintVals reference to result variable

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

Reimplemented from DcmElement.

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

get value multiplicity

Returns:
number of tag value pairs (group,element)

Implements DcmObject.

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

get element type identifier

Returns:
type identifier of this class (EVR_AT)

Implements DcmObject.

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

assignment operator

Parameters:

obj element to be assigned/copied

Returns:
reference to this object

virtual void DcmAttributeTag::print ( ostream & out,

const size_t flags = 0,

const int level = 0,

const char * pixelFileName = NULL,

size_t * pixelCounter = NULL

) [virtual]

print element to a stream.
The output format of the value is a backslash separated sequence of group and element value pairs, e.g. "(0008,0020)\(0008,0030)"
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.

virtual OFCondition DcmAttributeTag::putString ( const char * stringVal ) [virtual]

set element value from the given character string.
The input string is expected to be a backslash separated sequence of attribute tags, e.g. "(0008,0020)\(0008,0030)". This is the same format as used by "print()".
Parameters:

stringVal input character string

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

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::putTagVal ( const DcmTagKey & tagVal,

const unsigned long pos = 0

) [virtual]

set particular tag value

Parameters:

tagVal tag value to be set

pos index of the value to be set (0 = first position)

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

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::putUint16Array ( const Uint16 * uintVals,

const unsigned long numUints

) [virtual]

set element value to given integer array data.
The array entries with an even-numbered index are expected to contain the group numbers and the odd entries to contain the element numbers, e.g. {0x0008, 0x0020, 0x0008, 0x0030}. This function uses the same format as "getUint16Array()".
Parameters:

uintVals unsigned integer data to be set

numUints number of integer values to be set (should be even)

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

Reimplemented from DcmElement.

virtual OFCondition DcmAttributeTag::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.

The documentation for this class was generated from the following file:

dcmdata/include/dcmtk/dcmdata/dcvrat.h

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5

DcmAttributeTag Class Reference

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation