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::detector_event_timeline_reader_provider Class Referenceabstract

Interface to serve detector_event_timeline_reader given a key. More...

#include <vitrio/detector_event_timeline_reader_provider.hpp>

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

Public Member Functions

 detector_event_timeline_reader_provider (const detector_event_timeline_reader_provider &other)=delete
 
 detector_event_timeline_reader_provider (detector_event_timeline_reader_provider &&other)=delete
 
detector_event_timeline_reader_provider & operator= (const detector_event_timeline_reader_provider &other)=delete
 
detector_event_timeline_reader_provider & operator= (detector_event_timeline_reader_provider &&other)=delete
 
virtual std::shared_ptr< const detector_event_timeline_reader > acquire (const std::string &key)=0
 Get the reader a key names.
 

Detailed Description

Interface to serve detector_event_timeline_reader given a key.

What a key is and how the reader is created are left to the implementation. A key is often the path of a file, and need not be.

Thread safety
A provider may be asked for readers concurrently.
See also
image_reader_provider

Member Function Documentation

◆ acquire()

virtual std::shared_ptr< const detector_event_timeline_reader > vitrio::detector_event_timeline_reader_provider::acquire ( const std::string &  key)
pure virtual

Get the reader a key names.

Parameters
keyKey of the acquisition to read, such as the path of its file.
Returns
std::shared_ptr<const detector_event_timeline_reader> The reader, never null.
Exceptions
image_file_errorIf the file does not exist or can not be read.
unsupported_operation_errorIf no format can read the file.
image_file_format_errorIf the file is malformed or truncated.

Implemented in vitrio::file_detector_event_timeline_reader_provider.


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