DCMTK Version 3.7.0 OFFIS DICOM Toolkit

Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
DVStudyCache Class Reference

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

## 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 More...
Uint32 | getCount () const
| gets number of cache entries More...
OFBool | gotoItem (Uint32 idx)
| sets internal cursor to specified position in cache list More...
OFBool | gotoFirst ()
| sets internal cursor to first position in cache list More...
OFBool | gotoNext ()
| sets internal cursor to next position in cache list More...
OFBool | isElem (const OFString &uid)
| checks whether an item with the specified UID exists in the cache list More...
DVIFhierarchyStatus | getStatus () const
| gets review status of the current (selected) sstudy More...
ItemStruct * | getItem () const
| gets reference to current (selected) study More...
void | addItem (const OFString &uid, const DVIFhierarchyStatus status=DVIF_objectIsNew)
| adds a new item to the cache list. More...
void | updateStatus ()
| updates hierarchical/review status for all list items. More...

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

## Member Function Documentation

## ◆ addItem()

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)

## ◆ empty()

OFBool DVStudyCache::empty | ( |  | ) | const
| inline

checks whether study cache is empty

Returns
  OFTrue if cache is empty, OFFalse otherwise

## ◆ getCount()

Uint32 DVStudyCache::getCount | ( |  | ) | const
| inline

gets number of cache entries

Returns
  number of cache entries

## ◆ getItem()

ItemStruct* DVStudyCache::getItem | ( |  | ) | const
| inline

gets reference to current (selected) study

Returns
  pointer to ItemStruct if successful, NULL otherwise

## ◆ getStatus()

DVIFhierarchyStatus DVStudyCache::getStatus | ( |  | ) | const
| inline

gets review status of the current (selected) sstudy

Returns
  hierarchical status code if successful, 'isNew' otherwise

References DVStudyCache::ItemStruct::Status.

## ◆ gotoFirst()

OFBool DVStudyCache::gotoFirst | ( |  | ) |
| inline

sets internal cursor to first position in cache list

Returns
  OFTrue if successful, OFFalse if list is empty

## ◆ gotoItem()

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

## ◆ gotoNext()

OFBool DVStudyCache::gotoNext | ( |  | ) |
| inline

sets internal cursor to next position in cache list

Returns
  OFTrue if successful, OFFalse if new position is invalid

## ◆ isElem()

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

## ◆ updateStatus()

void DVStudyCache::updateStatus | ( |  | ) |
| inline

updates hierarchical/review status for all list items.

Returns
  resulting review status (summary of all items)

References DVStudyCache::ItemStruct::List, DVStudyCache::ItemStruct::Status, and DVSeriesCache::updateStatus().

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

- dcmpstat/include/dcmtk/dcmpstat/dvcache.h

Generated on Mon Dec 15 2025 for DCMTK Version 3.7.0 by Doxygen 1.9.1