DcmTagKey Class Reference

class maintaining a attribute tag (group and element number) More...

Inheritance diagram for DcmTagKey:

List of all members.

Public Member Functions
	DcmTagKey ()
	default constructor
	DcmTagKey (const DcmTagKey &key)
	copy constructor
	DcmTagKey (Uint16 g, Uint16 e)
	constructor
virtual	~DcmTagKey ()
	destructor
void	set (const DcmTagKey &key)
	set value to given tag key
void	set (Uint16 g, Uint16 e)
	set value to given group and element
void	setGroup (Uint16 g)
	set group to given number
void	setElement (Uint16 e)
	set element to given number
Uint16	getGroup () const
	returns group number
Uint16	getElement () const
	returns element number
DcmTagKey	getBaseTag () const
	returns base tag, i.e.
OFBool	isGroupLength () const
	checks whether the tag key is a valid group length element.
OFBool	isPrivate () const
	returns true if the tag key is private, i.e.
OFBool	isPrivateReservation () const
	returns true, if tag is a private reservation tag of the form (gggg,00xx) with "gggg" being odd and "xx" in the range of 10 and FF.
OFBool	hasValidGroup () const
	returns true, if group is valid (permitted in DICOM command or data sets).
Uint32	hash () const
	generate a simple hash code for this attribute tag.
DcmTagKey &	operator= (const DcmTagKey &key)
	assignment operator for initializing this tag key from an existing one
int	operator== (const DcmTagKey &key) const
	Comparison operator.
int	operator!= (const DcmTagKey &key) const
	negation operator.
int	operator< (const DcmTagKey &key) const
	'less than' operator.
int	operator> (const DcmTagKey &key) const
	'greater than' operator.
int	operator<= (const DcmTagKey &key) const
	'less or equal' operator.
int	operator>= (const DcmTagKey &key) const
	'greater or equal' operator.
OFString	toString () const
	convert tag key to string having the form "(gggg,eeee)".
OFBool	isSignableTag () const
	returns true if a data element with the given tag key can be digitally signed, false otherwise
Protected Member Functions
int	groupLT (const DcmTagKey &key) const
	less-than operation comparing only group numbers
int	groupGT (const DcmTagKey &key) const
	greater-than operation comparing only group numbers
int	groupEQ (const DcmTagKey &key) const
	comparison operation comparing only group numbers
int	elementLT (const DcmTagKey &key) const
	less-than operation comparing only element numbers
int	elementGT (const DcmTagKey &key) const
	greater-than operation comparing only element numbers
int	elementEQ (const DcmTagKey &key) const
	comparison operation comparing only element numbers
Private Attributes
Uint16	group
	tag group number
Uint16	element
	tag element number
Friends
DCMTK_DCMDATA_EXPORT STD_NAMESPACE ostream &	operator<< (STD_NAMESPACE ostream &s, const DcmTagKey &k)
	stream output operator for tag keys

---

Detailed Description

class maintaining a attribute tag (group and element number)

---

Constructor & Destructor Documentation

DcmTagKey::DcmTagKey

(

const DcmTagKey &

key

)

[inline]

copy constructor

Parameters:

key	[in] The tag key to initialize from

DcmTagKey::DcmTagKey	(	Uint16	g,
		Uint16	e
	)		[inline]

constructor

Parameters:

g	group
e	element

---

Member Function Documentation

DcmTagKey DcmTagKey::getBaseTag

(

)

const

returns base tag, i.e.

in case of a repeating group tag always the base group number 0x5000 (curve) or 0x6000 (overlay) is used. For non-repeating group tags "this" tag key is returned.

Returns:

returns the base tag of the tag key

Uint16 DcmTagKey::getElement

(

)

const [inline]

returns element number

Returns:

returns the element number of the tag key

Uint16 DcmTagKey::getGroup

(

)

const [inline]

returns group number

Returns:

returns the group number of the tag key

Uint32 DcmTagKey::hash

(

)

const [inline]

generate a simple hash code for this attribute tag.

Used for fast look-up in the DICOM dictionary.

Returns:

hash code for this tag

OFBool DcmTagKey::hasValidGroup

(

)

const [inline]

returns true, if group is valid (permitted in DICOM command or data sets).

Referring to the standard, groups 1, 3, 5, 7 and 0xFFFF are illegal.

Returns:

returns OFTrue if tag key has a valid group number.

OFBool DcmTagKey::isGroupLength

(

)

const [inline]

checks whether the tag key is a valid group length element.

Also calls hasValidGroup().

Returns:

returns OFTrue if tag key is a valid group length element

OFBool DcmTagKey::isPrivate

(

)

const [inline]

returns true if the tag key is private, i.e.

whether it has an odd group number. Also hasValidGroup() is called.

Returns:

returns OFTrue if group is private and valid.

OFBool DcmTagKey::isPrivateReservation

(

)

const [inline]

returns true, if tag is a private reservation tag of the form (gggg,00xx) with "gggg" being odd and "xx" in the range of 10 and FF.

Returns:

returns OFTrue if tag key is a private reservation key

OFBool DcmTagKey::isSignableTag

(

)

const

returns true if a data element with the given tag key can be digitally signed, false otherwise

Returns:

true if signable, false otherwise

int DcmTagKey::operator!=

(

const DcmTagKey &

key

)

const [inline]

negation operator.

Returns true if either group or element number are not the same.

Parameters:

key	key to compare with

Returns:

true if tag keys are not the same

int DcmTagKey::operator<

(

const DcmTagKey &

key

)

const [inline]

'less than' operator.

Returns true if the given tag key is greater than "this".

Parameters:

key	key to compare with

Returns:

true if given key is greater than "this"

int DcmTagKey::operator<=

(

const DcmTagKey &

key

)

const [inline]

'less or equal' operator.

Returns true if the given tag key is greater or the same as "this".

Parameters:

key	key to compare with

Returns:

true if given key is greater or the same as "this"

DcmTagKey & DcmTagKey::operator=

(

const DcmTagKey &

key

)

[inline]

assignment operator for initializing this tag key from an existing one

Parameters:

key	[in] The key to copy from

Returns:

"this" initialization

int DcmTagKey::operator==

(

const DcmTagKey &

key

)

const [inline]

Comparison operator.

Returns true if both group and element number are the same.

Parameters:

key	key to compare with

Returns:

true if tag keys are the same

int DcmTagKey::operator>

(

const DcmTagKey &

key

)

const [inline]

'greater than' operator.

Returns true if the given tag key is smaller than "this".

Parameters:

key	key to compare with

Returns:

true if "this" key is smaller than given one.

int DcmTagKey::operator>=

(

const DcmTagKey &

key

)

const [inline]

'greater or equal' operator.

Returns true if the given tag key is smaller or equal as "this".

Parameters:

key	key to compare with

Returns:

true if "this" key is smaller or equal to given one.

void DcmTagKey::set

(

const DcmTagKey &

key

)

[inline]

set value to given tag key

Parameters:

key	attribute tag to copy

void DcmTagKey::set	(	Uint16	g,
		Uint16	e
	)		[inline]

set value to given group and element

Parameters:

g	group
e	element

void DcmTagKey::setElement

(

Uint16

e

)

[inline]

set element to given number

Parameters:

e

element

void DcmTagKey::setGroup

(

Uint16

g

)

[inline]

set group to given number

Parameters:

g

group

OFString DcmTagKey::toString

(

)

const

convert tag key to string having the form "(gggg,eeee)".

Returns:

the string representation of this tag key

---

Friends And Related Function Documentation

DCMTK_DCMDATA_EXPORT STD_NAMESPACE ostream& operator<<	(	STD_NAMESPACE ostream &	s,
		const DcmTagKey &	k
	)		[friend]

stream output operator for tag keys

Parameters:

s	output stream
k	tag key

Returns:

reference to output stream

---

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

• dcmdata/include/dcmtk/dcmdata/dctagkey.h