Orion
high-rate readout
Public Member Functions | List of all members
itk::itkpix::endec::intf::OutputCallback Class Referenceabstract

Callback interface for output. More...

#include <outcallback.hpp>

Inheritance diagram for itk::itkpix::endec::intf::OutputCallback:
Inheritance graph
[legend]

Public Member Functions

virtual ~OutputCallback ()=default
 Destructor.
 
virtual void out_init ()=0
 Create a new stream and start a new event.
 
virtual void out_next (uint8_t nbits)=0
 Complete the event and start the next one. More...
 
virtual void out_done (uint8_t nbits)=0
 Complete the event and finalize the stream. More...
 
virtual void out_data (uint64_t data)=0
 Output 64-bit data word for current event. More...
 
virtual uint8_t on_error (OutputError error)=0
 Callback on encoding error. More...
 

Detailed Description

Callback interface for output.

Member Function Documentation

◆ on_error()

virtual uint8_t itk::itkpix::endec::intf::OutputCallback::on_error ( OutputError  error)
pure virtual

Callback on encoding error.

Parameters
error- event error
Returns
- feedback on error, 0 - continue decoding, 1 - drop the rest of the event

Implemented in itk::itkpix::endec::orion::OutputCallback< T >, and itk::itkpix::endec::dummy::OutputCallback.

◆ out_data()

virtual void itk::itkpix::endec::intf::OutputCallback::out_data ( uint64_t  data)
pure virtual

Output 64-bit data word for current event.

Parameters
data- 64 bit data frame

Implemented in itk::itkpix::endec::orion::OutputCallback< T >, and itk::itkpix::endec::dummy::OutputCallback.

◆ out_done()

virtual void itk::itkpix::endec::intf::OutputCallback::out_done ( uint8_t  nbits)
pure virtual

Complete the event and finalize the stream.

Parameters
nbits- number of output bits of the last event, all padding bits are filled with zeroes.

Implemented in itk::itkpix::endec::orion::OutputCallback< T >, and itk::itkpix::endec::dummy::OutputCallback.

◆ out_next()

virtual void itk::itkpix::endec::intf::OutputCallback::out_next ( uint8_t  nbits)
pure virtual

Complete the event and start the next one.

Parameters
nbits- number of output bits of the completed event.

Implemented in itk::itkpix::endec::orion::OutputCallback< T >, and itk::itkpix::endec::dummy::OutputCallback.


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