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...

List of all members.

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
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.
DcmInputStreamgetStream ()
 return input stream
offile_off_t getOffset () const
 return initial stream offset

Private Member Functions

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

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.

Definition at line 42 of file dcfcache.h.


Member Function Documentation

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:
object pointer to "user object"

Definition at line 64 of file dcfcache.h.

References user_.

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

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

Parameters:
stream stream object
user user object

Definition at line 83 of file dcfcache.h.

References clear(), offset_, stream_, DcmInputStream::tell(), and user_.


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