|
DCMTK Version 3.6.9
OFFIS DICOM Toolkit
|
each object of this class manages one entry of the global DICOM data dictionary. More...
Inheritance diagram for DcmDictEntry:Public Member Functions | |
| DcmDictEntry (Uint16 g, Uint16 e, DcmVR vr, const char *nam, int vmMin, int vmMax, const char *vers, OFBool doCopyStrings, const char *pcreator) | |
| constructor | |
| DcmDictEntry (Uint16 g, Uint16 e, Uint16 ug, Uint16 ue, DcmVR vr, const char *nam, int vmMin, int vmMax, const char *vers, OFBool doCopyStrings, const char *pcreator) | |
| constructor for repeating tags | |
| DcmDictEntry (const DcmDictEntry &e) | |
| copy constructor | |
| ~DcmDictEntry () | |
| destructor | |
| DcmVR | getVR () const |
| returns VR object by value | |
| DcmEVR | getEVR () const |
| returns VR code | |
| const char * | getStandardVersion () const |
| returns standard version string, may be NULL | |
| const char * | getTagName () const |
| returns tag name | |
| const char * | getPrivateCreator () const |
| returns private creator identifier, may be NULL | |
| int | privateCreatorMatch (const char *c) const |
| checks if the private creator identifier equals the given string | |
| int | privateCreatorMatch (const DcmDictEntry &arg) const |
| checks if the private creator identifier of this object matches the one of the given object. | |
| int | getVMMin () const |
| returns lower limit for VM (value multiplicity) | |
| int | getVMMax () const |
| returns upper limit for VM (value multiplicity), DcmVariableVM for unlimited | |
| OFBool | isFixedSingleVM () const |
| returns true if element has a single valid VM value | |
| OFBool | isFixedRangeVM () const |
| returns true if element has a fixed VM range | |
| OFBool | isVariableRangeVM () const |
| returns true if element has a variable VM range (no upper limit) | |
| void | setUpper (const DcmTagKey &key) |
| converts entry into repeating tag entry by defining an upper limit for group and element, taken from the given tag key. | |
| void | setUpperGroup (Uint16 ug) |
| converts entry into repeating tag entry by defining an upper limit for tag group | |
| void | setUpperElement (Uint16 ue) |
| converts entry into repeating tag entry by defining an upper limit for tag element | |
| Uint16 | getUpperGroup () const |
| returns upper limit for tag group | |
| Uint16 | getUpperElement () const |
| returns upper limit for tag element | |
| DcmTagKey | getKey () const |
| returns attribute tag as DcmTagKey object by value | |
| DcmTagKey | getUpperKey () const |
| returns upper limits for attribute tag as DcmTagKey object by value | |
| int | isRepeatingGroup () const |
| returns true if entry is has a repeating group | |
| int | isRepeatingElement () const |
| returns true if entry is has a repeating element | |
| int | isRepeating () const |
| returns true if entry is repeating (group or element) | |
| DcmDictRangeRestriction | getGroupRangeRestriction () const |
| returns group range restriction | |
| void | setGroupRangeRestriction (DcmDictRangeRestriction rr) |
| sets group range restriction | |
| DcmDictRangeRestriction | getElementRangeRestriction () const |
| returns element range restriction | |
| void | setElementRangeRestriction (DcmDictRangeRestriction rr) |
| sets element range restriction | |
| int | contains (const DcmTagKey &key, const char *privCreator) const |
| checks if the given tag key and private creator identifier are covered by this object. | |
| int | contains (const char *name) const |
| checks if this entry contains the given name | |
| int | subset (const DcmDictEntry &e) const |
| checks if this entry describes a true subset of tag range described by the given entry. | |
| int | setEQ (const DcmDictEntry &e) const |
| checks if this entry describes the same tag range as the given entry. | |
Public Member Functions inherited from DcmTagKey | |
| 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 | |
| OFBool | operator== (const DcmTagKey &key) const |
| comparison operator. | |
| OFBool | operator!= (const DcmTagKey &key) const |
| negation operator. | |
| OFBool | operator< (const DcmTagKey &key) const |
| 'less than' operator. | |
| OFBool | operator> (const DcmTagKey &key) const |
| 'greater than' operator. | |
| OFBool | operator<= (const DcmTagKey &key) const |
| 'less or equal' operator. | |
| OFBool | 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 | |
Private Member Functions | |
| DcmDictEntry & | operator= (const DcmDictEntry &) |
| private undefined copy assignment operator | |
Private Attributes | |
| DcmTagKey | upperKey |
| upper limit of repeating group and element (lower limit is inherited from DcmTagKey) | |
| DcmVR | valueRepresentation |
| value representation | |
| const char * | tagName |
| attribute name | |
| int | valueMultiplicityMin |
| lower limit for VM | |
| int | valueMultiplicityMax |
| upper limit for VM | |
| const char * | standardVersion |
| standard version name, may be NULL | |
| OFBool | stringsAreCopies |
| true if strings are copies (i.e. should be deleted upon destruction) | |
| DcmDictRangeRestriction | groupRangeRestriction |
| restriction (even, odd, unrestricted) for group range | |
| DcmDictRangeRestriction | elementRangeRestriction |
| restriction (even, odd, unrestricted) for element range | |
| const char * | privateCreator |
| private creator identifier, may be NULL | |
Friends | |
| DCMTK_DCMDATA_EXPORT STD_NAMESPACE ostream & | operator<< (STD_NAMESPACE ostream &s, const DcmDictEntry &e) |
| friend operator<< | |
Additional Inherited Members | |
Protected Member Functions inherited from DcmTagKey | |
| 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 | |
each object of this class manages one entry of the global DICOM data dictionary.
| DcmDictEntry::DcmDictEntry | ( | Uint16 | g, |
| Uint16 | e, | ||
| DcmVR | vr, | ||
| const char * | nam, | ||
| int | vmMin, | ||
| int | vmMax, | ||
| const char * | vers, | ||
| OFBool | doCopyStrings, | ||
| const char * | pcreator ) |
constructor
| g | attribute tag group |
| e | attribute tag element |
| vr | value representation |
| nam | attribute name |
| vmMin | lower limit for value multiplicity |
| vmMax | upper limit for value multiplicity, DcmVariableVM for unlimited |
| vers | standard version name, may be NULL |
| doCopyStrings | true if strings should be copied, false if only referenced |
| pcreator | private creator identifier, may be NULL (for standard tags) |
Referenced by DcmDictEntry(), operator<<, operator=(), privateCreatorMatch(), setEQ(), and subset().
| DcmDictEntry::DcmDictEntry | ( | Uint16 | g, |
| Uint16 | e, | ||
| Uint16 | ug, | ||
| Uint16 | ue, | ||
| DcmVR | vr, | ||
| const char * | nam, | ||
| int | vmMin, | ||
| int | vmMax, | ||
| const char * | vers, | ||
| OFBool | doCopyStrings, | ||
| const char * | pcreator ) |
constructor for repeating tags
| g | attribute tag group lower limit |
| e | attribute tag element lower limit |
| ug | attribute tag group upper limit |
| ue | attribute tag element upper limit |
| vr | value representation |
| nam | attribute name |
| vmMin | lower limit for value multiplicity |
| vmMax | upper limit for value multiplicity, DcmVariableVM for unlimited |
| vers | standard version name, may be NULL |
| doCopyStrings | true if strings should be copied, false if only referenced |
| pcreator | private creator identifier, may be NULL (for standard tags) |
| DcmDictEntry::DcmDictEntry | ( | const DcmDictEntry & | e | ) |
|
inline |
checks if this entry contains the given name
| name | attribute name, must not be NULL |
References tagName.
|
inline |
checks if the given tag key and private creator identifier are covered by this object.
| key | tag key |
| privCreator | private creator identifier, may be NULL |
References DcmTagKey::DcmTagKey(), DcmTagKey::getElement(), getElementRangeRestriction(), DcmTagKey::getGroup(), getGroupRangeRestriction(), getUpperElement(), getUpperGroup(), and privateCreatorMatch().
|
inline |
checks if the private creator identifier equals the given string
| c | string to compare with, may be NULL |
References privateCreator.
Referenced by contains(), privateCreatorMatch(), setEQ(), and subset().
|
inline |
checks if the private creator identifier of this object matches the one of the given object.
| arg | dictionary entry to compare with |
References DcmDictEntry(), privateCreator, and privateCreatorMatch().
|
inline |
sets element range restriction
| rr | the new range restriction |
References elementRangeRestriction.
|
inline |
checks if this entry describes the same tag range as the given entry.
| e | entry to compare with |
References DcmDictEntry(), DcmTagKey::getElement(), getElementRangeRestriction(), DcmTagKey::getGroup(), getGroupRangeRestriction(), getUpperElement(), getUpperGroup(), and privateCreatorMatch().
|
inline |
sets group range restriction
| rr | the new range restriction |
References groupRangeRestriction.
|
inline |
converts entry into repeating tag entry by defining an upper limit for group and element, taken from the given tag key.
| key | tag key containing upper limit for group and element |
References DcmTagKey::DcmTagKey(), and upperKey.
|
inline |
converts entry into repeating tag entry by defining an upper limit for tag element
| ue | upper limit for tag element |
References upperKey.
|
inline |
converts entry into repeating tag entry by defining an upper limit for tag group
| ug | upper limit for tag group |
References upperKey.
|
inline |
checks if this entry describes a true subset of tag range described by the given entry.
| e | entry to compare with |
References DcmDictEntry(), DcmTagKey::getElement(), DcmTagKey::getGroup(), getUpperElement(), getUpperGroup(), and privateCreatorMatch().
|
friend |
friend operator<<
| s | the ostream to append upon |
| e | the dictionary entry |
References DcmDictEntry().