BmnRoot 26.10.0-18-g4e3414f9
Software framework of the BM@N experiment
Loading...
Searching...
No Matches
fles::Microslice Class Referenceabstract

The Microslice class provides read access to the data of a microslice. More...

#include <Microslice.h>

Inheritance diagram for fles::Microslice:
Collaboration diagram for fles::Microslice:

Public Member Functions

virtual ~Microslice ()=0
const MicrosliceDescriptor & desc () const
 Retrieve microslice descriptor reference.
const uint8_t * content () const
 Retrieve a pointer to the microslice data.
uint32_t compute_crc () const
 Compute CRC-32 checksum of microslice data content.
bool check_crc () const
 Compare computed CRC-32 checksum to value in header.
virtual ~Microslice ()=0
const MicrosliceDescriptor & desc () const
 Retrieve microslice descriptor reference.
const uint8_t * content () const
 Retrieve a pointer to the microslice data.
uint32_t compute_crc () const
 Compute CRC-32 checksum of microslice data content.
bool check_crc () const
 Compare computed CRC-32 checksum to value in header.

Protected Member Functions

 Microslice ()=default
 Microslice (MicrosliceDescriptor *desc_ptr, uint8_t *content_ptr)
 Construct microslice with given content.
 Microslice ()=default
 Microslice (MicrosliceDescriptor *desc_ptr, uint8_t *content_ptr)
 Construct microslice with given content.

Protected Attributes

MicrosliceDescriptor * desc_ptr_
 Pointer to the microslice descriptor.
uint8_t * content_ptr_
 Pointer to the microslice data content.

Friends

class StorableMicroslice

Detailed Description

This class is an abstract base class for all classes providing access to the descriptor and data contents of a single microslice.

Definition at line 24 of file Microslice.h.

Constructor & Destructor Documentation

◆ ~Microslice() [1/2]

virtual fles::Microslice::~Microslice ( )
pure virtual

◆ Microslice() [1/4]

fles::Microslice::Microslice ( )
protecteddefault

Referenced by fles::StorableMicroslice::StorableMicroslice(), fles::StorableMicroslice::boost::serialization::access, and fles::StorableMicroslice::initialize_crc().

Here is the caller graph for this function:

◆ Microslice() [2/4]

fles::Microslice::Microslice ( MicrosliceDescriptor * desc_ptr,
uint8_t * content_ptr )
inlineprotected

Definition at line 45 of file Microslice.h.

References content_ptr_, and desc_ptr_.

◆ ~Microslice() [2/2]

virtual fles::Microslice::~Microslice ( )
pure virtual

◆ Microslice() [3/4]

fles::Microslice::Microslice ( )
protecteddefault

◆ Microslice() [4/4]

fles::Microslice::Microslice ( MicrosliceDescriptor * desc_ptr,
uint8_t * content_ptr )
inlineprotected

Definition at line 45 of file Microslice.h.

References content_ptr_, and desc_ptr_.

Member Function Documentation

◆ check_crc() [1/2]

bool fles::Microslice::check_crc ( ) const

◆ check_crc() [2/2]

bool fles::Microslice::check_crc ( ) const

◆ compute_crc() [1/2]

uint32_t fles::Microslice::compute_crc ( ) const

◆ compute_crc() [2/2]

uint32_t fles::Microslice::compute_crc ( ) const

◆ content() [1/2]

const uint8_t * fles::Microslice::content ( ) const
inline

Definition at line 33 of file Microslice.h.

References content_ptr_.

Referenced by fles::MicrosliceView::MicrosliceView().

Here is the caller graph for this function:

◆ content() [2/2]

const uint8_t * fles::Microslice::content ( ) const
inline

Definition at line 33 of file Microslice.h.

References content_ptr_.

◆ desc() [1/2]

const MicrosliceDescriptor & fles::Microslice::desc ( ) const
inline

Definition at line 30 of file Microslice.h.

References desc_ptr_.

◆ desc() [2/2]

const MicrosliceDescriptor & fles::Microslice::desc ( ) const
inline

Definition at line 30 of file Microslice.h.

References desc_ptr_.

◆ StorableMicroslice

StorableMicroslice
friend

Definition at line 49 of file Microslice.h.

References StorableMicroslice.

Referenced by StorableMicroslice.

Member Data Documentation

◆ content_ptr_

uint8_t * fles::Microslice::content_ptr_
protected

◆ desc_ptr_

MicrosliceDescriptor * fles::Microslice::desc_ptr_
protected

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