fire v0.19.0
Framework for sImulation and Reconstruction of Events
fire::io::h5::Reader::BufferHandle Class Referenceabstract

Type-less handle to the Buffer. More...

Inheritance diagram for fire::io::h5::Reader::BufferHandle:
[legend]
Collaboration diagram for fire::io::h5::Reader::BufferHandle:
[legend]

Public Member Functions

 BufferHandle (std::size_t max, HighFive::DataSet s)
 Define the size of the in-memory buffer and the set we are reading from. More...
 
virtual ~BufferHandle ()=default
 virtual destructor to pass on to derived types
 
virtual void load ()=0
 pure virtual load function to be defined when we know the type More...
 

Protected Attributes

std::size_t max_len_
 the maximum length of the buffer
 
HighFive::DataSet set_
 the HDF5 dataset we are reading from
 

Detailed Description

Type-less handle to the Buffer.

This base class allows us to hold the DataSet being read from and hold all of the Buffers of atomic types in a single map.

Constructor & Destructor Documentation

◆ BufferHandle()

fire::io::h5::Reader::BufferHandle::BufferHandle ( std::size_t  max,
HighFive::DataSet  s 
)
inlineexplicit

Define the size of the in-memory buffer and the set we are reading from.

Parameters
[in]maxmaximum number of elements allowed in-memory
[in]sDataSet we are reading from

Member Function Documentation

◆ load()

virtual void fire::io::h5::Reader::BufferHandle::load ( )
pure virtual

pure virtual load function to be defined when we know the type

This isn't used outside of the Buffer class but it is helpful in making sure future developments don't inadvertently abuse the BufferHandle class which is meant to be abstract.

Implemented in fire::io::h5::Reader::Buffer< AtomicType >.


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