DCMTree_FileCache.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2008, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef DCM_TREE_FILE_CACHE_H
#define DCM_TREE_FILE_CACHE_H
 
#include "DCMTree_TagId.h"
 
#include <string>
 
namespace DCMTree
{
  // Abstract base class for a DICOM tag cache
  // a DICOM tag can be left in file and read on demand
  // The file cache class handles the read requests
 
  class DCMTREE_EXPORT FileCache
  {
  public:
    virtual ~FileCache() = default;
 
    // init the file cache for filename filename and the DICOM tag id
    virtual void init(std::string const & filename, TagId const & id) =0;
    virtual bool isInitialized() const =0;
    // copy DICOM attribute value to buffer dest with size bufSize
    // caller needs to prepare buffer with right size
    // For values with multiple entries (especially multiframe images)
    // idx is the index of the requested value
    virtual bool getValue(boost::uint32_t idx, unsigned char *dest, boost::uint32_t bufSize) =0;
    virtual bool getValue(boost::uint32_t idx, unsigned char *dest, boost::uint32_t bufSize,
                          std::string & colorModel, unsigned int & fragment) =0;
  };
}
 
#endif