DCMTK Version 3.6.8
OFFIS DICOM Toolkit
Public Member Functions | Private Member Functions | Private Attributes | List of all members
DcmFileCache Class Reference

This class implements a simple container that stores an input stream, the position of that input stream corresponding to the start of a DICOM element value field contained in the stream and the current "owner" object. More...

Public Member Functions

 DcmFileCache ()
 default constructor
 
 ~DcmFileCache ()
 destructor
 
OFBool isUser (void *object) const
 checks if the given object is the current user of this cache returns true if so, false otherwise More...
 
void clear ()
 returns object to default constructed state

 
void init (DcmInputStream *stream, void *user)
 initializes the file cache with the given stream object and user. More...
 
DcmInputStreamgetStream ()
 return input stream
 
offile_off_t getOffset () const
 return initial stream offset

 

Private Member Functions

 DcmFileCache (const DcmFileCache &arg)
 private undefined copy constructor More...
 
DcmFileCacheoperator= (const DcmFileCache &arg)
 private undefined copy assignment operator More...
 

Private Attributes

DcmInputStreamstream_
 input stream, may be NULL
 
offile_off_t offset_
 offset within stream for initial position
 
const void * user_
 object that currently uses the file cache, i.e. has created the stream
 

Detailed Description

This class implements a simple container that stores an input stream, the position of that input stream corresponding to the start of a DICOM element value field contained in the stream and the current "owner" object.

It is used to keep a single file handle open during multiple calls to DcmElement::getPartialValue(), thus speeding up the reading.

Constructor & Destructor Documentation

◆ DcmFileCache()

DcmFileCache::DcmFileCache ( const DcmFileCache arg)
private

private undefined copy constructor

Parameters
argdocumented to avoid doxygen warnings

Member Function Documentation

◆ init()

void DcmFileCache::init ( DcmInputStream stream,
void *  user 
)
inline

initializes the file cache with the given stream object and user.

Parameters
streamstream object
useruser object

References DcmInputStream::tell().

◆ isUser()

OFBool DcmFileCache::isUser ( void *  object) const
inline

checks if the given object is the current user of this cache returns true if so, false otherwise

Parameters
objectpointer to "user object"

◆ operator=()

DcmFileCache & DcmFileCache::operator= ( const DcmFileCache arg)
private

private undefined copy assignment operator

Parameters
argthe cache to copy

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


Generated on Tue Dec 19 2023 for DCMTK Version 3.6.8 by Doxygen 1.9.4