vtk-dicom  0.8.14
Public Types | Public Member Functions | List of all members
vtkDICOMVR Class Reference

VRs (Value Representations) More...

#include <vtkDICOMVR.h>

Public Types

enum  EnumType {
  XX = 0x00 , AE = 0x01 , AS = 0x02 , AT = 0x03 ,
  CS = 0x04 , DA = 0x05 , DS = 0x06 , DT = 0x07 ,
  FD = 0x08 , FL = 0x09 , IS = 0x0a , LO = 0x0b ,
  LT = 0x0c , OB = 0x0d , OD = 0x0e , OF = 0x0f ,
  OL = 0x10 , OW = 0x11 , PN = 0x12 , SH = 0x13 ,
  SL = 0x14 , SQ = 0x15 , SS = 0x16 , ST = 0x17 ,
  TM = 0x18 , UC = 0x19 , UI = 0x1a , UL = 0x1b ,
  UN = 0x1c , UR = 0x1d , US = 0x1e , UT = 0x1f ,
  OX = 0x20 , XS = 0x21 , OV = 0x22 , SV = 0x23 ,
  UV = 0x24
}
 The VR enum constants. More...
 

Public Member Functions

 vtkDICOMVR ()
 Construct an empty, invalid VR.
 
 vtkDICOMVR (EnumType vr)
 Construct a VR from a VR enum constant.
 
 vtkDICOMVR (const char *vr)
 Attempt to construct a VR from a two-byte string.
 
 vtkDICOMVR (const unsigned char vr[2])
 Attempt to construct a VR from a two unsigned bytes.
 
bool IsValid () const
 Check validity of this VR.
 
int GetType () const
 Get the data type for this VR.
 
const char * GetText () const
 Get the two-character text for this VR.
 
bool HasLongVL () const
 The VRs OB, OD, OF, OL, OW, OV, SQ, UC, UN, UR, UT require a 32-bit VL.
 
bool HasSpecificCharacterSet () const
 The VRs SH, LO, PN, ST, LT, UC, and UT use SpecificCharacterSet.
 
bool HasTextValue () const
 This is true for all VRs whose value is stored as text.
 
bool HasNumericValue () const
 This is true for for all VRs that store numbers. More...
 
bool HasSingleValue () const
 The VRs ST, LT, and UT carry only one value. More...
 
bool operator== (vtkDICOMVR a) const
 
bool operator!= (vtkDICOMVR a) const
 
bool operator<= (vtkDICOMVR a) const
 
bool operator>= (vtkDICOMVR a) const
 
bool operator< (vtkDICOMVR a) const
 
bool operator> (vtkDICOMVR a) const
 

Detailed Description

VRs (Value Representations)

Member Enumeration Documentation

◆ EnumType

The VR enum constants.

Sorting the constants numerically will sort the VRs alphabetically.

Enumerator
XX 

Null (No Value)

AE 

Application Entity.

AS 

Age String.

AT 

Attribute Tag.

CS 

Code String.

DA 

Date.

DS 

Decimal String.

DT 

Date Time.

FD 

Floating Point Double.

FL 

Floating Point Single.

IS 

Integer String.

LO 

Long String.

LT 

Long Text.

OB 

Other Byte.

OD 

Other Double.

OF 

Other Float.

OL 

Other Long.

OW 

Other Word.

PN 

Personal Name.

SH 

Short String.

SL 

Signed Long.

SQ 

Sequence of Items.

SS 

Signed Short.

ST 

Short Text.

TM 

Time.

UC 

Unlimited Characters.

UI 

Unique Identifier.

UL 

Unsigned Long.

UN 

Unknown.

UR 

URI or URL.

US 

Unsigned Short.

UT 

Unlimited Text.

OX 

Either OB or OW (for dict entries, not data elements)

XS 

Either SS or US (for dict entries, not data elements)

OV 

Other Very Long.

SV 

Signed Very Long.

UV 

Unsigned Very Long.

Member Function Documentation

◆ HasNumericValue()

bool vtkDICOMVR::HasNumericValue ( ) const
inline

This is true for for all VRs that store numbers.

The VRs included are IS, DS, US, UL, UV, SS, SL, SV, FL, FD. The VRs OB, OW, OL, OV, OF, and OD are not included.

◆ HasSingleValue()

bool vtkDICOMVR::HasSingleValue ( ) const
inline

The VRs ST, LT, and UT carry only one value.

Specifically, this means that a backslash is not interpreted as a value separator in these VRs. UR is not included, because backslash is an illegal character in UR.


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