BmnRoot
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:
[legend]
Collaboration diagram for fles::Microslice:
[legend]

Public Member Functions

virtual ~Microslice ()=0
 
const MicrosliceDescriptordesc () 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 MicrosliceDescriptordesc () 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

MicrosliceDescriptordesc_ptr_
 Pointer to the microslice descriptor.
 
uint8_t * content_ptr_
 Pointer to the microslice data content.
 

Friends

class StorableMicroslice
 

Detailed Description

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

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 23 of file Microslice.h.

Constructor & Destructor Documentation

◆ ~Microslice() [1/2]

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

◆ Microslice() [1/4]

fles::Microslice::Microslice ( )
protecteddefault

◆ Microslice() [2/4]

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

Construct microslice with given content.

Definition at line 44 of file Microslice.h.

◆ ~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

Construct microslice with given content.

Definition at line 44 of file Microslice.h.

Member Function Documentation

◆ check_crc() [1/2]

bool fles::Microslice::check_crc ( ) const

Compare computed CRC-32 checksum to value in header.

◆ check_crc() [2/2]

bool fles::Microslice::check_crc ( ) const

Compare computed CRC-32 checksum to value in header.

◆ compute_crc() [1/2]

uint32_t fles::Microslice::compute_crc ( ) const

Compute CRC-32 checksum of microslice data content.

◆ compute_crc() [2/2]

uint32_t fles::Microslice::compute_crc ( ) const

Compute CRC-32 checksum of microslice data content.

◆ content() [1/2]

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

Retrieve a pointer to the microslice data.

Definition at line 32 of file Microslice.h.

References content_ptr_.

◆ content() [2/2]

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

Retrieve a pointer to the microslice data.

Definition at line 32 of file Microslice.h.

References content_ptr_.

◆ desc() [1/2]

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

Retrieve microslice descriptor reference.

Definition at line 29 of file Microslice.h.

References desc_ptr_.

◆ desc() [2/2]

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

Retrieve microslice descriptor reference.

Definition at line 29 of file Microslice.h.

References desc_ptr_.

Friends And Related Symbol Documentation

◆ StorableMicroslice

Definition at line 48 of file Microslice.h.

Member Data Documentation

◆ content_ptr_

uint8_t * fles::Microslice::content_ptr_
protected

Pointer to the microslice data content.

Definition at line 54 of file Microslice.h.

Referenced by fles::StorableMicroslice::content(), and content().

◆ desc_ptr_

MicrosliceDescriptor * fles::Microslice::desc_ptr_
protected

Pointer to the microslice descriptor.

Definition at line 51 of file Microslice.h.

Referenced by fles::StorableMicroslice::desc(), and desc().


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