vitrio 0.1.4
High-throughput image I/O for Cryo-Electron Microscopy (CryoEM)
Loading...
Searching...
No Matches
Public Member Functions | List of all members
vitrio::image_scratch Class Referenceabstract

Copies of image files, kept where they are faster to reach than the files themselves. More...

#include <vitrio/image_scratch.hpp>

Inheritance diagram for vitrio::image_scratch:
Inheritance graph
[legend]

Public Member Functions

 image_scratch (const image_scratch &other)=delete
 
 image_scratch (image_scratch &&other)=delete
 
image_scratch & operator= (const image_scratch &other)=delete
 
image_scratch & operator= (image_scratch &&other)=delete
 
virtual std::shared_ptr< image_scratch_entry > find (const std::string &key)=0
 Get what is held of a file, to read it and to add to it.
 

Detailed Description

Copies of image files, kept where they are faster to reach than the files themselves.

A scratch holds one image_scratch_entry for each file it keeps something of, and finds it by the key of that file. What an entry keeps of its file is the entry's implementation's own business.

Thread safety
Every method may be called concurrently.

Member Function Documentation

◆ find()

virtual std::shared_ptr< image_scratch_entry > vitrio::image_scratch::find ( const std::string &  key)
pure virtual

Get what is held of a file, to read it and to add to it.

Shared ownership rather than a reference, so that an entry stays alive for as long as it is still read through.

Parameters
keyKey of the file.
Returns
std::shared_ptr<image_scratch_entry> The entry of the file, or null when nothing of it is held.

Implemented in vitrio::indexed_image_scratch.


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