DVStudyCache Class Reference

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

Collaboration diagram for DVStudyCache:

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

Public Member Functions
	DVStudyCache ()
	Constructor.
virtual	~DVStudyCache ()
	Destructor.
void	clear ()
	reset all member variables to initial state delete all list items.
OFBool	empty () const
	checks whether study 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	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) sstudy
ItemStruct *	getItem () const
	gets reference to current (selected) study
void	addItem (const OFString &uid, const DVIFhierarchyStatus status=DVIF_objectIsNew)
	adds a new item to the cache list.
void	updateStatus ()
	updates hierarchical/review status for all list items.

Protected Member Functions
	OFListIterator (ItemStruct *) Iterator
	internal cursor to current (selected) list item

Protected Attributes
OFList< ItemStruct * >	List
	list of studies

Detailed Description

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

This is the highest level in the hierarchical cache structure. This class is used by DVInterface. The internal structure is a list of DVSeriesCache.

Definition at line 689 of file dvcache.h.

Member Function Documentation

void DVStudyCache::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 869 of file dvcache.h.

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

OFBool DVStudyCache::empty ( void  ) const

inline

checks whether study cache is empty

Returns

OFTrue if cache is empty, OFFalse otherwise

Definition at line 755 of file dvcache.h.

References OFList< T >::empty().

Uint32 DVStudyCache::getCount ( ) const

inline

gets number of cache entries

Returns

number of cache entries

Definition at line 764 of file dvcache.h.

References OFList< T >::size().

ItemStruct* DVStudyCache::getItem ( ) const

inline

gets reference to current (selected) study

Returns

pointer to ItemStruct if successful, NULL otherwise

Definition at line 857 of file dvcache.h.

References OFList< T >::end().

DVIFhierarchyStatus DVStudyCache::getStatus ( ) const

inline

gets review status of the current (selected) sstudy

Returns

hierarchical status code if successful, 'isNew' otherwise

Definition at line 847 of file dvcache.h.

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

OFBool DVStudyCache::gotoFirst ( )

inline

sets internal cursor to first position in cache list

Returns

OFTrue if successful, OFFalse if list is empty

Definition at line 797 of file dvcache.h.

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

OFBool DVStudyCache::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 775 of file dvcache.h.

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

OFBool DVStudyCache::gotoNext ( )

inline

sets internal cursor to next position in cache list

Returns

OFTrue if successful, OFFalse if new position is invalid

Definition at line 808 of file dvcache.h.

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

OFBool DVStudyCache::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 822 of file dvcache.h.

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

void DVStudyCache::updateStatus ( )

inline

updates hierarchical/review status for all list items.

Returns

resulting review status (summary of all items)

Definition at line 881 of file dvcache.h.

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

---

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

• dcmpstat/include/dcmtk/dcmpstat/dvcache.h