DcmXfer Class Reference

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

Public Member Functions
	DcmXfer (E_TransferSyntax xfer)
	constructor More...
	DcmXfer (const char *xferName_xferID)
	constructor More...
	DcmXfer (const DcmXfer &newXfer)
	copy constructor
	~DcmXfer ()
	destructor
DcmXfer &	operator= (const E_TransferSyntax xfer)
	assignment operator for transfer syntax enum
DcmXfer &	operator= (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
E_ByteOrder	getPixelDataByteOrder () 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. More...
Uint32	getJPEGProcess12Bit () const
	return 12-bit JPEG process ID for this transfer syntax. More...
OFBool	isLossy () const
	check whether transfer syntax uses a lossy compression More...
OFBool	isLossless () const
	check whether transfer syntax uses a lossless compression or no compression More...
OFBool	isRetired () const
	check whether transfer syntax is retired More...
E_StreamCompression	getStreamCompression () const
	get stream compression type for this transfer syntax More...
OFBool	isReferenced () const
	check whether transfer syntax uses (0028,7FE0) Pixel Data Provider URL to reference pixel data More...
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. More...

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_ByteOrder	pixelDataByteOrder
	transfer syntax byte order for pixel data
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	lossy
	flag indicating whether this transfer syntax uses a lossy compression
OFBool	retired
	flag indicating whether this transfer syntax has been retired from DICOM
E_StreamCompression	streamCompression
	transfer syntax stream compression type
OFBool	referenced
	flag indicating whether this transfer syntax uses a pixel data URL reference

Detailed Description

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

Constructor & Destructor Documentation

DcmXfer() [1/2]

DcmXfer::DcmXfer

(

E_TransferSyntax

xfer

)

constructor

Parameters

xfer	transfer syntax enum

DcmXfer() [2/2]

DcmXfer::DcmXfer

(

const char *

xferName_xferID

)

constructor

Parameters

xferName_xferID

transfer syntax name as string

Member Function Documentation

getJPEGProcess12Bit()

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

getJPEGProcess8Bit()

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

getStreamCompression()

E_StreamCompression DcmXfer::getStreamCompression ( ) const

inline

get stream compression type for this transfer syntax

Returns

stream compression type for this transfer syntax

isLossless()

OFBool DcmXfer::isLossless ( ) const

inline

check whether transfer syntax uses a lossless compression or no compression

Returns

true if transfer syntax uses a lossless compression or no compression, false otherwise

isLossy()

OFBool DcmXfer::isLossy ( ) const

inline

check whether transfer syntax uses a lossy compression

Returns

true if transfer syntax uses a lossy compression, false otherwise

isReferenced()

OFBool DcmXfer::isReferenced ( ) const

inline

check whether transfer syntax uses (0028,7FE0) Pixel Data Provider URL to reference pixel data

Returns

true if transfer syntax uses URL reference to pixel data

isRetired()

OFBool DcmXfer::isRetired ( ) const

inline

check whether transfer syntax is retired

Returns

true if transfer syntax is retired, false otherwise

sizeofTagHeader()

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:

• dcmdata/include/dcmtk/dcmdata/dcxfer.h