OFFIS DCMTK  Version 3.6.0
Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
DcmTagKey Class Reference

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

Inheritance diagram for DcmTagKey:
[legend]

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
 
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, ie.
 
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 files).
 
Uint32 hash () const
 generate a simple hash code for this attribute tag, used for fast look-up in the DICOM dictionary
 
DcmTagKeyoperator= (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

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)

Definition at line 46 of file dctagkey.h.

Constructor & Destructor Documentation

DcmTagKey::DcmTagKey ( const DcmTagKey key)
inline

copy constructor

Parameters
key[in] The tag key to initialize from

Definition at line 243 of file dctagkey.h.

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

constructor

Parameters
ggroup
eelement

Definition at line 250 of file dctagkey.h.

Member Function Documentation

Uint16 DcmTagKey::getElement ( ) const
inline

returns element number

Returns
Returns the element number of the tag key

Definition at line 296 of file dctagkey.h.

References element.

Referenced by DcmDictEntry::contains(), elementEQ(), elementGT(), elementLT(), DcmTag::getETag(), DcmDictEntry::getUpperElement(), hash(), DcmDictEntry::isRepeatingElement(), DcmDictEntry::setEQ(), and DcmDictEntry::subset().

Uint16 DcmTagKey::getGroup ( ) const
inline

returns group number

Returns
returns the group number of the tag key

Definition at line 290 of file dctagkey.h.

References group.

Referenced by DcmDictEntry::contains(), DcmTag::getGTag(), DcmDictEntry::getUpperGroup(), groupEQ(), groupGT(), groupLT(), hash(), DcmDictEntry::isRepeatingGroup(), DcmDictEntry::setEQ(), and DcmDictEntry::subset().

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

Definition at line 340 of file dctagkey.h.

References getElement(), and getGroup().

OFBool DcmTagKey::hasValidGroup ( ) const
inline

returns true, if group is valid (permitted in DICOM files).

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

Returns
returns OFTrue if tag key has a valid group number.

Definition at line 321 of file dctagkey.h.

References group.

Referenced by isGroupLength(), and isPrivate().

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

Definition at line 302 of file dctagkey.h.

References element, and hasValidGroup().

OFBool DcmTagKey::isPrivate ( ) const
inline

returns true if the tag key is private, ie.

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

Returns
returns OFTrue if group is private and valid.

Definition at line 308 of file dctagkey.h.

References group, and hasValidGroup().

Referenced by isPrivateReservation().

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

Definition at line 314 of file dctagkey.h.

References element, and isPrivate().

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
keykey to compare with
Returns
true if tag keys are not the same

Definition at line 391 of file dctagkey.h.

int DcmTagKey::operator< ( const DcmTagKey key) const
inline

'less than' operator.

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

Parameters
keykey to compare with
Returns
true if given key is greater than "this"

Definition at line 397 of file dctagkey.h.

References elementLT(), groupEQ(), and groupLT().

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
keykey to compare with
Returns
true if given key is greater or the same as "this"

Definition at line 409 of file dctagkey.h.

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

Definition at line 331 of file dctagkey.h.

int DcmTagKey::operator== ( const DcmTagKey key) const
inline

Comparison operator.

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

Parameters
keykey to compare with
Returns
true if tag keys are the same

Definition at line 385 of file dctagkey.h.

References elementEQ(), and groupEQ().

int DcmTagKey::operator> ( const DcmTagKey key) const
inline

'greater than' operator.

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

Parameters
keykey to compare with
Returns
true if "this" key is smaller than given one.

Definition at line 403 of file dctagkey.h.

References elementGT(), groupEQ(), and groupGT().

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
keykey to compare with
Returns
true if "this" key is smaller or equal to given one.

Definition at line 415 of file dctagkey.h.

void DcmTagKey::set ( const DcmTagKey key)
inline

set value to given tag key

Parameters
keyattribute tag to copy

Definition at line 264 of file dctagkey.h.

References element, and group.

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

set value to given group and element

Parameters
ggroup
eelement

Definition at line 271 of file dctagkey.h.

References element, and group.

void DcmTagKey::setElement ( Uint16  e)
inline

set element to given number

Parameters
eelement

Definition at line 284 of file dctagkey.h.

References element.

Referenced by DcmDictEntry::setUpperElement().

void DcmTagKey::setGroup ( Uint16  g)
inline

set group to given number

Parameters
ggroup

Definition at line 278 of file dctagkey.h.

References group.

Referenced by DcmObject::setGTag(), and DcmDictEntry::setUpperGroup().

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

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

stream output operator for tag keys

Parameters
soutput stream
ktag key
Returns
reference to output stream

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


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2