DcmVR Class Reference

a class representing a DICOM Value Representation More...

List of all members.

Public Member Functions
	DcmVR ()
	default constructor
	DcmVR (DcmEVR evr)
	constructor
	DcmVR (const char *vrName)
	constructor
	DcmVR (const DcmVR &avr)
	copy constructor
void	setVR (DcmEVR evr)
	assign new VR value
void	setVR (const char *vrName)
	assign new VR value by name
void	setVR (const DcmVR &avr)
	assign new VR value
DcmVR &	operator= (const DcmVR &arg)
	copy assignment operator
DcmEVR	getEVR () const
	get enumerated VR managed by this object
DcmEVR	getValidEVR () const
	get enumerated standard VR managed by this object.
const char *	getVRName () const
	get symbolic VR name for this object
const char *	getValidVRName () const
	get symbolic standard VR name for this object If this object manages a non-standard, internal VR such as EVR_ox, this method returns the name of the VR to which the internal VR will be mapped when writing the DICOM object.
size_t	getValueWidth () const
	compute the size for non-empty values of this VR.
OFBool	isStandard () const
	returns true if VR is a standard DICOM VR
OFBool	isForInternalUseOnly () const
	returns true if VR is for internal use only
OFBool	isaString () const
	returns true if VR represents a string
OFBool	usesExtendedLengthEncoding () const
	returns true if VR uses an extended length encoding for explicit transfer syntaxes
OFBool	isEquivalent (const DcmVR &avr) const
	check if VRs are equivalent VRs are considered equivalent if equal or if one of them is an internal VR and the other one is a possible standard VR to which the internal one maps.
Uint32	getMinValueLength () const
	return minimum length of a value with this VR (in bytes), assuming single byte characters
Uint32	getMaxValueLength () const
	return maximum length of a value with this VR (in bytes), assuming single byte characters
Private Attributes
DcmEVR	vr
	the enumerated VR value

---

Detailed Description

a class representing a DICOM Value Representation

---

Constructor & Destructor Documentation

DcmVR::DcmVR

(

DcmEVR

evr

)

[inline]

constructor

Parameters:

evr	enumerated VR value

DcmVR::DcmVR

(

const char *

vrName

)

[inline]

constructor

Parameters:

vrName

symbolic name of value representation

DcmVR::DcmVR

(

const DcmVR &

avr

)

[inline]

copy constructor

Parameters:

avr

VR value

---

Member Function Documentation

DcmEVR DcmVR::getEVR

(

)

const [inline]

get enumerated VR managed by this object

Returns:

enumerated VR

Uint32 DcmVR::getMaxValueLength

(

)

const

return maximum length of a value with this VR (in bytes), assuming single byte characters

Returns:

maximum length of a value

Uint32 DcmVR::getMinValueLength

(

)

const

return minimum length of a value with this VR (in bytes), assuming single byte characters

Returns:

minimum length of a value

DcmEVR DcmVR::getValidEVR

(

)

const

get enumerated standard VR managed by this object.

If this object manages a non-standard, internal VR such as EVR_ox, this method returns the enumerated VR to which the internal VR will be mapped when writing the DICOM object.

Please note that some VR, e.g. EVR_pixelItem, won't be written as EVR_UNKNOWN, although this method will return that value for them. This means that e.g. usesExtendedLengthEncoding() for the returned VR might not be correct.

Also note that DcmItem::checkAndUpdateVR() will in some cases influence the VR which is written out.

Returns:

enumerated VR

const char* DcmVR::getValidVRName

(

)

const

get symbolic standard VR name for this object If this object manages a non-standard, internal VR such as EVR_ox, this method returns the name of the VR to which the internal VR will be mapped when writing the DICOM object.

Returns:

VR name string, never NULL

size_t DcmVR::getValueWidth

(

)

const

compute the size for non-empty values of this VR.

For fixed size VRs such as OW, US, SL, the method returns the size of each value, in bytes. For variable length VRs (strings), it returns 1. For internal VRs it returns 0.

Returns:

size of values of this VR

const char* DcmVR::getVRName

(

)

const

get symbolic VR name for this object

Returns:

VR name string, never NULL

OFBool DcmVR::isaString

(

)

const

returns true if VR represents a string

Returns:

true if VR represents a string

OFBool DcmVR::isEquivalent

(

const DcmVR &

avr

)

const

check if VRs are equivalent VRs are considered equivalent if equal or if one of them is an internal VR and the other one is a possible standard VR to which the internal one maps.

Parameters:

avr	VR to compare with

Returns:

true if VRs are equivalent, false otherwise

OFBool DcmVR::isForInternalUseOnly

(

)

const

returns true if VR is for internal use only

Returns:

true if VR is for internal use only

OFBool DcmVR::isStandard

(

)

const

returns true if VR is a standard DICOM VR

Returns:

true if VR is a standard DICOM VR

DcmVR& DcmVR::operator=

(

const DcmVR &

arg

)

[inline]

copy assignment operator

Parameters:

arg	vr to assign from

void DcmVR::setVR

(

DcmEVR

evr

)

assign new VR value

Parameters:

evr	enumerated VR value

void DcmVR::setVR

(

const char *

vrName

)

assign new VR value by name

Parameters:

vrName

symbolic name of value representation

void DcmVR::setVR

(

const DcmVR &

avr

)

[inline]

assign new VR value

Parameters:

avr

VR value

OFBool DcmVR::usesExtendedLengthEncoding

(

)

const

returns true if VR uses an extended length encoding for explicit transfer syntaxes

Returns:

true if VR uses an extended length encoding for explicit transfer syntaxes

---

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

• dcmdata/include/dcmtk/dcmdata/dcvr.h