a class representing a DICOM Value Representation
More...
a class representing a DICOM Value Representation
| DcmVR::DcmVR |
( |
const char * |
vrName | ) |
|
|
inline |
constructor
- Parameters
-
| vrName | symbolic name of value representation |
| DcmVR::DcmVR |
( |
const DcmVR & |
avr | ) |
|
|
inline |
copy constructor
- Parameters
-
| const OFString& DcmVR::getDelimiterChars |
( |
| ) |
const |
retrieve delimiter characters to be used for character set conversion (to switch back to the default character set in case code extension techniques like ISO 2022 are used).
- Returns
- a reference to an OFString containing the delimiter characters for this VR or a reference to an empty OFString.
| 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::isAffectedBySpecificCharacterSet |
( |
| ) |
const |
return whether elements of this VR are affected by SpecificCharacterSet
- Returns
- true for the following VRs: PN, LO, LT, SH, ST, UC and UT, false for all others.
| OFBool DcmVR::isaString |
( |
| ) |
const |
returns true if VR represents a string
- Returns
- true if VR represents a string, false otherwise
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
-
- 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, false otherwise
| OFBool DcmVR::isStandard |
( |
| ) |
const |
returns true if VR is a standard DICOM VR
- Returns
- true if VR is a standard DICOM VR, false otherwise
copy assignment operator
- Parameters
-
- Returns
- reference to this object
References vr.
| void DcmVR::setVR |
( |
DcmEVR |
evr | ) |
|
assign new VR value
- Parameters
-
| 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
-
References vr.
| 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, false otherwise
The documentation for this class was generated from the following file:
- dcmdata/include/dcmtk/dcmdata/dcvr.h
