DcmXfer Class Reference

a class that allows for a lookup of Transfer Syntax properties and readable descriptions More...

List of all members.

Public Member Functions

 DcmXfer (E_TransferSyntax xfer)
 constructor
 DcmXfer (const char *xferName_xferID)
 constructor
 DcmXfer (const DcmXfer &newXfer)
 copy constructor
 ~DcmXfer ()
 destructor
DcmXferoperator= (const E_TransferSyntax xfer)
 assignment operator for transfer syntax enum
DcmXferoperator= (const DcmXfer &newtag)
 copy assignment operator
E_TransferSyntax getXfer () const
 return transfer syntax enum for this transfer syntax
E_ByteOrder getByteOrder () const
 return byte order for this transfer syntax
const char * getXferName () const
 return name string for this transfer syntax
const char * getXferID () const
 return UID string for this transfer syntax
OFBool isLittleEndian () const
 return true if transfer syntax is little endian, false otherwise
OFBool isBigEndian () const
 return true if transfer syntax is big endian, false otherwise
OFBool isImplicitVR () const
 return true if transfer syntax is implicit VR, false otherwise
OFBool isExplicitVR () const
 return true if transfer syntax is explicit VR, false otherwise
OFBool isEncapsulated () const
 return true if transfer syntax is encapsulated, false otherwise
OFBool isNotEncapsulated () const
 return true if transfer syntax is native (non-encapsulated), false otherwise
Uint32 getJPEGProcess8Bit () const
 return 8-bit JPEG process ID for this transfer syntax.
Uint32 getJPEGProcess12Bit () const
 return 12-bit JPEG process ID for this transfer syntax.
OFBool isRetired () const
 return true if transfer syntax is retired, false otherwise
E_StreamCompression getStreamCompression () const
 return stream compression type for this transfer syntax
Uint32 sizeofTagHeader (DcmEVR evr) const
 return the number of bytes needed to describe the tag, length, VR and any reserved fields for this transfer syntax when encoding the specified VR.

Private Attributes

const char * xferID
 transfer syntax UID
const char * xferName
 transfer syntax name
E_TransferSyntax xferSyn
 transfer syntax enum
E_ByteOrder byteOrder
 transfer syntax byte order
E_VRType vrType
 transfer syntax VR encoding (implicit/explicit)
E_JPEGEncapsulated encapsulated
 transfer syntax encapsulated or native
Uint32 JPEGProcess8
 8-bit lossy JPEG process ID for this transfer syntax, 0 if not applicable
Uint32 JPEGProcess12
 12-bit lossy JPEG process ID for this transfer syntax, 0 if not applicable
OFBool retired
 flag indicating whether this transfer syntax has been retired from DICOM
E_StreamCompression streamCompression
 transfer syntax stream compression type


Detailed Description

a class that allows for a lookup of Transfer Syntax properties and readable descriptions

Definition at line 161 of file dcxfer.h.


Constructor & Destructor Documentation

DcmXfer::DcmXfer ( E_TransferSyntax  xfer  ) 

constructor

Parameters:
xfer transfer syntax enum

DcmXfer::DcmXfer ( const char *  xferName_xferID  ) 

constructor

Parameters:
xferName_xferID transfer syntax name as string


Member Function Documentation

Uint32 DcmXfer::getJPEGProcess8Bit (  )  const [inline]

return 8-bit JPEG process ID for this transfer syntax.

Lossy JPEG transfer syntaxes support two alternative JPEG encoding processes - 8 and 12 bits. When called for a non-JPEG transfer syntax, returns 0.

Returns:
8-bit JPEG process ID

Definition at line 230 of file dcxfer.h.

References JPEGProcess8.

Uint32 DcmXfer::getJPEGProcess12Bit (  )  const [inline]

return 12-bit JPEG process ID for this transfer syntax.

Lossy JPEG transfer syntaxes support two alternative JPEG encoding processes - 8 and 12 bits. When called for a non-JPEG transfer syntax, returns 0.

Returns:
12-bit JPEG process ID

Definition at line 237 of file dcxfer.h.

References JPEGProcess12.

Uint32 DcmXfer::sizeofTagHeader ( DcmEVR  evr  )  const

return the number of bytes needed to describe the tag, length, VR and any reserved fields for this transfer syntax when encoding the specified VR.

Parameters:
evr value representation to be encoded in this transfer syntax
Returns:
number of bytes needed


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


Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1