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

Callback interface for event. More...

#include <evtcallback.hpp>

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

Public Member Functions

virtual ~EventCallback ()=default
 Destructor.
 
virtual void evt_init (uint8_t tag)=0
 Initialize a new stream and create a new event. More...
 
virtual void evt_next (uint8_t tag)=0
 Complete the event and start the next one. More...
 
virtual void evt_done ()=0
 Complete the event and finalize the stream.
 
virtual void add_hit (uint16_t col, uint16_t row, uint16_t tot)=0
 Add hit. More...
 
virtual void add_hmap (uint8_t qcol, uint8_t qrow, uint16_t hmap, uint64_t tots)=0
 Add quarter core: rawmap is decoded, tots are not decoded. More...
 
virtual void add_qcore (uint8_t qcol, uint8_t qrow, uint64_t qtot)=0
 Add quarter core: tots are decoded to 64 bit qtot, no-hit marked as 0xF. More...
 
virtual uint8_t on_error (EventError error)=0
 Callback on decoding error. More...
 

Detailed Description

Callback interface for event.

Member Function Documentation

◆ add_hit()

virtual void itk::itkpix::endec::intf::EventCallback::add_hit ( uint16_t  col,
uint16_t  row,
uint16_t  tot 
)
pure virtual

Add hit.

Parameters
col- column
row- row
tot- tot

Implemented in itk::itkpix::endec::dummy::EventCallback.

◆ add_hmap()

virtual void itk::itkpix::endec::intf::EventCallback::add_hmap ( uint8_t  qcol,
uint8_t  qrow,
uint16_t  hmap,
uint64_t  tots 
)
pure virtual

Add quarter core: rawmap is decoded, tots are not decoded.

Parameters
qcol- quarter core column
qrow- quarter core row
hmap- decoded 16 bit hitmap
tots- undecoded ToT bits

Implemented in itk::itkpix::endec::dummy::EventCallback.

◆ add_qcore()

virtual void itk::itkpix::endec::intf::EventCallback::add_qcore ( uint8_t  qcol,
uint8_t  qrow,
uint64_t  qtot 
)
pure virtual

Add quarter core: tots are decoded to 64 bit qtot, no-hit marked as 0xF.

Parameters
qcol- quarter core column
qrow- quarter core row
qtot- decoded 16x4 bits of ToT according to hitmap, no-hit marked as 0xF

Implemented in itk::itkpix::endec::dummy::EventCallback.

◆ evt_init()

virtual void itk::itkpix::endec::intf::EventCallback::evt_init ( uint8_t  tag)
pure virtual

Initialize a new stream and create a new event.

Parameters
tag- trigger tag of a new event

Implemented in itk::itkpix::endec::dummy::EventCallback.

◆ evt_next()

virtual void itk::itkpix::endec::intf::EventCallback::evt_next ( uint8_t  tag)
pure virtual

Complete the event and start the next one.

Parameters
tag- trigger tag of a new event

Implemented in itk::itkpix::endec::dummy::EventCallback.

◆ on_error()

virtual uint8_t itk::itkpix::endec::intf::EventCallback::on_error ( EventError  error)
pure virtual

Callback on decoding error.

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

Implemented in itk::itkpix::endec::dummy::EventCallback.


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