OFFIS DCMTK  Version 3.6.0
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DVInstanceCache Class Reference

A class to handle an instance cache (list of items). More...

Collaboration diagram for DVInstanceCache:
[legend]

Classes

struct  ItemStruct
 Internal structure defining the list items. More...
 

Public Member Functions

 DVInstanceCache ()
 Constructor.
 
virtual ~DVInstanceCache ()
 Destructor.
 
void clear ()
 reset all member variables to initial state.
 
OFBool empty () const
 checks whether instance cache is empty
 
Uint32 getCount () const
 gets number of cache entries
 
OFBool gotoItem (Uint32 idx)
 sets internal cursor to specified position in cache list
 
OFBool gotoFirst ()
 sets internal cursor to first position in cache list
 
OFBool gotoNext ()
 sets internal cursor to next position in cache list
 
OFBool reset ()
 sets internal cursor to last visited position in cache list
 
OFBool isElem (const OFString &uid)
 checks whether an item with the specified UID exists in the cache list
 
int getPos () const
 gets the file position of the current (selected) instance
 
DVIFhierarchyStatus getStatus () const
 gets review status of the current (selected) instance
 
DVPSInstanceType getType () const
 gets type of the instance
 
int getImageSize () const
 gets image size of current (selected) instance
 
const char * getFilename () const
 gets filename of current (selected) instance
 
ItemStructgetItem () const
 gets reference to current (selected) instance
 
void addItem (const OFString &uid, const int pos, const DVIFhierarchyStatus status, const DVPSInstanceType type, const int size, const OFString &filename)
 adds a new item to the cache list.
 
DVIFhierarchyStatus updateStatus ()
 updates hierarchical/review status for all list items.
 

Protected Member Functions

 OFListIterator (ItemStruct *) Iterator
 internal cursor to current (selected) list item
 
 OFListIterator (ItemStruct *) OldIterator
 last visited position in item list
 

Protected Attributes

OFList< ItemStruct * > List
 list of instances
 

Detailed Description

A class to handle an instance cache (list of items).

This is the lowest level in the hierarchical cache structure. Images are handled as well as presentation states. This class is used by DVSeriesCache.

Definition at line 70 of file dvcache.h.

Member Function Documentation

void DVInstanceCache::addItem ( const OFString uid,
const int  pos,
const DVIFhierarchyStatus  status,
const DVPSInstanceType  type,
const int  size,
const OFString filename 
)
inline

adds a new item to the cache list.

sets internal cursor to new position.

Parameters
uidunique identifier
posfile position in index file
statusreview status
typetype of instance
sizeimage size (in bytes)
filenamefilename of instance

Definition at line 342 of file dvcache.h.

References OFList< T >::end(), List, and OFList< T >::push_back().

void DVInstanceCache::clear ( )
inline

reset all member variables to initial state.

delete all list items.

Definition at line 149 of file dvcache.h.

References OFList< T >::begin(), OFList< T >::clear(), OFList< T >::end(), OFList< T >::erase(), List, and OFListIterator().

Referenced by ~DVInstanceCache(), DVSeriesCache::~DVSeriesCache(), and DVStudyCache::~DVStudyCache().

OFBool DVInstanceCache::empty ( void  ) const
inline

checks whether instance cache is empty

Returns
OFTrue if cache is empty, OFFalse otherwise

Definition at line 166 of file dvcache.h.

References OFList< T >::empty(), and List.

Uint32 DVInstanceCache::getCount ( ) const
inline

gets number of cache entries

Returns
number of cache entries

Definition at line 175 of file dvcache.h.

References List, and OFList< T >::size().

const char* DVInstanceCache::getFilename ( ) const
inline

gets filename of current (selected) instance

Returns
filename if successful, NULL otherwise

Definition at line 316 of file dvcache.h.

References OFString::c_str(), DVInstanceCache::ItemStruct::Filename, and getItem().

int DVInstanceCache::getImageSize ( ) const
inline

gets image size of current (selected) instance

Returns
image size in bytes if successful, 0 otherwise

Definition at line 306 of file dvcache.h.

References getItem(), and DVInstanceCache::ItemStruct::ImageSize.

ItemStruct* DVInstanceCache::getItem ( ) const
inline

gets reference to current (selected) instance

Returns
pointer to ItemStruct if successful, NULL otherwise

Definition at line 326 of file dvcache.h.

References OFList< T >::end(), and List.

Referenced by getFilename(), getImageSize(), getPos(), getStatus(), DVSeriesCache::getStatus(), DVStudyCache::getStatus(), getType(), and DVSeriesCache::getType().

int DVInstanceCache::getPos ( ) const
inline

gets the file position of the current (selected) instance

Returns
file position if successful, 0 otherwise

Definition at line 276 of file dvcache.h.

References getItem(), and DVInstanceCache::ItemStruct::Pos.

DVIFhierarchyStatus DVInstanceCache::getStatus ( ) const
inline

gets review status of the current (selected) instance

Returns
hierarchical status code if successful, 'isNew' otherwise

Definition at line 286 of file dvcache.h.

References getItem(), and DVInstanceCache::ItemStruct::Status.

DVPSInstanceType DVInstanceCache::getType ( ) const
inline

gets type of the instance

Returns
type of instance

Definition at line 296 of file dvcache.h.

References getItem(), and DVInstanceCache::ItemStruct::Type.

OFBool DVInstanceCache::gotoFirst ( )
inline

sets internal cursor to first position in cache list

Returns
OFTrue if successful, OFFalse if list is empty

Definition at line 208 of file dvcache.h.

References OFList< T >::begin(), OFList< T >::end(), and List.

OFBool DVInstanceCache::gotoItem ( Uint32  idx)
inline

sets internal cursor to specified position in cache list

Parameters
idxindex position in cache list (starting with 0)
Returns
OFTrue if successful, OFFalse if 'idx' is invalid

Definition at line 186 of file dvcache.h.

References OFList< T >::begin(), OFList< T >::end(), List, and OFListIterator().

OFBool DVInstanceCache::gotoNext ( )
inline

sets internal cursor to next position in cache list

Returns
OFTrue if successful, OFFalse if new position is invalid

Definition at line 219 of file dvcache.h.

References OFList< T >::end(), List, and OFListIterator().

OFBool DVInstanceCache::isElem ( const OFString uid)
inline

checks whether an item with the specified UID exists in the cache list

Parameters
uidUID which should be checked
Returns
OFTrue if such an item exists, OFFalse otherwise

Definition at line 251 of file dvcache.h.

References OFList< T >::begin(), OFList< T >::end(), List, OFListIterator(), and DVInstanceCache::ItemStruct::UID.

OFBool DVInstanceCache::reset ( )
inline

sets internal cursor to last visited position in cache list

Returns
OFTrue if successful, OFFalse if last visited position was invalid or the last one in the list

Definition at line 232 of file dvcache.h.

References OFList< T >::end(), List, and OFListIterator().

DVIFhierarchyStatus DVInstanceCache::updateStatus ( )
inline

updates hierarchical/review status for all list items.

Returns
resulting review status (summary of all items)

Definition at line 358 of file dvcache.h.

References OFList< T >::begin(), OFList< T >::end(), List, OFListIterator(), and DVInstanceCache::ItemStruct::Status.

Referenced by DVSeriesCache::updateStatus().


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


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2