DcmDictEntry Class Reference

each object of this class manages one entry of the global DICOM data dictionary. More...

Inheritance diagram for DcmDictEntry:

List of all members.

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 code, may be NULL
int	privateCreatorMatch (const char *c) const
	checks if the private creator code equals the given string
int	privateCreatorMatch (const DcmDictEntry &arg) const
	checks if the private creator code 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 code 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.
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 name, may be NULL
Friends
DCMTK_DCMDATA_EXPORT STD_NAMESPACE ostream &	operator<< (STD_NAMESPACE ostream &s, const DcmDictEntry &e)
	friend operator<<

---

Detailed Description

each object of this class manages one entry of the global DICOM data dictionary.

---

Constructor & Destructor Documentation

DcmDictEntry::DcmDictEntry	(	Uint16	g,
		Uint16	e,
		DcmVR	vr,
		const char *	nam,
		int	vmMin,
		int	vmMax,
		const char *	vers,
		OFBool	doCopyStrings,
		const char *	pcreator
	)

constructor

Parameters:

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 name, may be NULL (for standard tags)

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

Parameters:

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 name, may be NULL (for standard tags)

---

Member Function Documentation

int DcmDictEntry::contains	(	const DcmTagKey &	key,
		const char *	privCreator
	)		const [inline]

checks if the given tag key and private creator code are covered by this object.

Parameters:

key	tag key
privCreator	private creator, may be NULL

Returns:

true if this entry contains the given tag for the given private creator

int DcmDictEntry::contains

(

const char *

name

)

const [inline]

checks if this entry contains the given name

Parameters:

name	attribute name, must not be NULL

Returns:

true if tagName matches the given string

int DcmDictEntry::privateCreatorMatch

(

const char *

c

)

const [inline]

checks if the private creator code equals the given string

Parameters:

c	string to compare with, may be NULL

Returns:

true if equal, false otherwise

int DcmDictEntry::privateCreatorMatch

(

const DcmDictEntry &

arg

)

const [inline]

checks if the private creator code of this object matches the one of the given object.

Parameters:

arg	dictionary entry to compare with

Returns:

true if private creators are equal, false otherwise

int DcmDictEntry::setEQ

(

const DcmDictEntry &

e

)

const [inline]

checks if this entry describes the same tag range as the given entry.

Parameters:

e	entry to compare with

Returns:

true if objects describe the same tag range

void DcmDictEntry::setUpper

(

const DcmTagKey &

key

)

[inline]

converts entry into repeating tag entry by defining an upper limit for group and element, taken from the given tag key.

Parameters:

key	tag key containing upper limit for group and element

void DcmDictEntry::setUpperElement

(

Uint16

ue

)

[inline]

converts entry into repeating tag entry by defining an upper limit for tag element

Parameters:

ue	upper limit for tag element

void DcmDictEntry::setUpperGroup

(

Uint16

ug

)

[inline]

converts entry into repeating tag entry by defining an upper limit for tag group

Parameters:

ug	upper limit for tag group

int DcmDictEntry::subset

(

const DcmDictEntry &

e

)

const [inline]

checks if this entry describes a true subset of tag range described by the given entry.

Parameters:

e	entry to compare with

Returns:

true if this object is subset of e

---

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

• dcmdata/include/dcmtk/dcmdata/dcdicent.h