DVSeriesCache Class Reference

A class to handle a series cache (list of items). More...

List of all members.

Public Member Functions

 DVSeriesCache ()
 Constructor.
virtual ~DVSeriesCache ()
 Destructor.
void clear ()
 reset all member variables to initial state delete all list items.
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
DVIFhierarchyStatus getStatus () const
 gets review status of the current (selected) series
DVPSInstanceType getType () const
 gets type of all instances in the series
ItemStruct * getItem () const
 gets reference to current (selected) series
void addItem (const OFString &uid, const DVIFhierarchyStatus status=DVIF_objectIsNew)
 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 series

Classes

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

Detailed Description

A class to handle a series cache (list of items).

This is the middle level in the hierarchical cache structure. This class is used by DVStudyCache. The internal structure is a list of DVInstanceCache.

Definition at line 412 of file dvcache.h.

Member Function Documentation

void DVSeriesCache::addItem (  const OFString &  uid,
const DVIFhierarchyStatus  status = DVIF_objectIsNew
)  [inline]
 

adds a new item to the cache list.

sets internal cursor to new position.

Parameters:
uid unique identifier
status review status (optional)

Definition at line 625 of file dvcache.h.

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

OFBool DVSeriesCache::empty (  void   )  const [inline]
 

checks whether instance cache is empty

Returns:
OFTrue if cache is empty, OFFalse otherwise

Definition at line 484 of file dvcache.h.

References OFList< T >::empty().

Uint32 DVSeriesCache::getCount (   )  const [inline]
 

gets number of cache entries

Returns:
number of cache entries

Definition at line 493 of file dvcache.h.

References OFList< T >::size().

ItemStruct* DVSeriesCache::getItem (   )  const [inline]
 

gets reference to current (selected) series

Returns:
pointer to ItemStruct if successful, NULL otherwise

Definition at line 614 of file dvcache.h.

References OFList< T >::end().

DVIFhierarchyStatus DVSeriesCache::getStatus (   )  const [inline]
 

gets review status of the current (selected) series

Returns:
hierarchical status code if successful, 'isNew' otherwise

Definition at line 594 of file dvcache.h.

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

DVPSInstanceType DVSeriesCache::getType (   )  const [inline]
 

gets type of all instances in the series

Returns:
type of all instances

Definition at line 604 of file dvcache.h.

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

OFBool DVSeriesCache::gotoFirst (   )  [inline]
 

sets internal cursor to first position in cache list

Returns:
OFTrue if successful, OFFalse if list is empty

Definition at line 526 of file dvcache.h.

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

OFBool DVSeriesCache::gotoItem (  Uint32  idx  )  [inline]
 

sets internal cursor to specified position in cache list

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

Definition at line 504 of file dvcache.h.

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

OFBool DVSeriesCache::gotoNext (   )  [inline]
 

sets internal cursor to next position in cache list

Returns:
OFTrue if successful, OFFalse if new position is invalid

Definition at line 537 of file dvcache.h.

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

OFBool DVSeriesCache::isElem (  const OFString &  uid  )  [inline]
 

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

Parameters:
uid UID which should be checked
Returns:
OFTrue if such an item exists, OFFalse otherwise

Definition at line 569 of file dvcache.h.

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

OFBool DVSeriesCache::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 550 of file dvcache.h.

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

DVIFhierarchyStatus DVSeriesCache::updateStatus (   )  [inline]
 

updates hierarchical/review status for all list items.

Returns:
resulting review status (summary of all items)

Definition at line 637 of file dvcache.h.

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

Referenced by DVStudyCache::updateStatus().

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

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5