ant::UnpackerAcquFileFormat Class Reference

#include <UnpackerAcqu_detail.h>

Inheritance diagram for ant::UnpackerAcquFileFormat:

Public Types
using	queue_t = std::list< TEvent >

Public Member Functions
virtual void	FillEvents (queue_t &queue) noexcept=0
	FillEvents fills the given queue with more TEvent items (if any left) More...
virtual	~UnpackerAcquFileFormat ()
virtual double	PercentDone () const =0

Static Public Member Functions
static std::unique_ptr< UnpackerAcquFileFormat >	Get (const std::string &filename)
	Get a suitable instance for the given filename. More...

Protected Member Functions
virtual size_t	SizeOfHeader () const =0
virtual bool	InspectHeader (const std::vector< uint32_t > &buffer) const =0
virtual void	Setup (std::unique_ptr< RawFileReader > &&reader_, std::vector< std::uint32_t > &&buffer_)=0

Member Typedef Documentation

queue_t

using ant::UnpackerAcquFileFormat::queue_t = std::list<TEvent>

Constructor & Destructor Documentation

~UnpackerAcquFileFormat()

UnpackerAcquFileFormat::~UnpackerAcquFileFormat ( )

virtual

Member Function Documentation

FillEvents()

virtual void ant::UnpackerAcquFileFormat::FillEvents ( queue_t &  queue )

pure virtualnoexcept

FillEvents fills the given queue with more TEvent items (if any left)

Parameters

queue

Implemented in ant::unpacker::acqu::FileFormatBase.

Get()

unique_ptr< UnpackerAcquFileFormat > UnpackerAcquFileFormat::Get ( const std::string &  filename )

static

Get a suitable instance for the given filename.

Parameters

filename

the file to read

Returns

the instance, or nullptr if nothing found

Throws exception if something unusual is encountered.

Todo:

Check for big-endian/little-endian formatted files?

InspectHeader()

virtual bool ant::UnpackerAcquFileFormat::InspectHeader ( const std::vector< uint32_t > &  buffer ) const

protectedpure virtual

PercentDone()

virtual double ant::UnpackerAcquFileFormat::PercentDone ( ) const

pure virtual

Implemented in ant::unpacker::acqu::FileFormatBase.

Setup()

virtual void ant::UnpackerAcquFileFormat::Setup ( std::unique_ptr< RawFileReader > &&  reader_, std::vector< std::uint32_t > &&  buffer_  )

protectedpure virtual

SizeOfHeader()

virtual size_t ant::UnpackerAcquFileFormat::SizeOfHeader ( ) const

protectedpure virtual

Implemented in ant::unpacker::acqu::FileFormatMk1, and ant::unpacker::acqu::FileFormatMk2.

---

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

• src/unpacker/detail/UnpackerAcqu_detail.h
• src/unpacker/detail/UnpackerAcqu_detail.cc