fles::Timeslice Class Reference

The Timeslice class provides read access to the data of a timeslice. More...

#include <Timeslice.h>

Inheritance diagram for fles::Timeslice:

Collaboration diagram for fles::Timeslice:

Public Member Functions
virtual	~Timeslice ()=default
uint64_t	index () const
	Retrieve the timeslice index.
uint64_t	num_core_microslices () const
	Retrieve the number of core microslices.
uint64_t	num_microslices (uint64_t component) const
	Retrieve the total number of microslices.
uint64_t	num_components () const
	Retrieve the number of components (contributing input channels).
const uint8_t *	content (uint64_t component, uint64_t microslice) const
	Retrieve a pointer to the data content of a given microslice.
const MicrosliceDescriptor &	descriptor (uint64_t component, uint64_t microslice) const
	Retrieve the descriptor of a given microslice.
const MicrosliceView	get_microslice (uint64_t component, uint64_t microslice_index) const
	Retrieve the descriptor and pointer to the data of a given microslice.
virtual	~Timeslice ()=default
uint64_t	index () const
	Retrieve the timeslice index.
uint64_t	num_core_microslices () const
	Retrieve the number of core microslices.
uint64_t	num_microslices (uint64_t component) const
	Retrieve the total number of microslices.
uint64_t	num_components () const
	Retrieve the number of components (contributing input channels).
const uint8_t *	content (uint64_t component, uint64_t microslice) const
	Retrieve a pointer to the data content of a given microslice.
const MicrosliceDescriptor &	descriptor (uint64_t component, uint64_t microslice) const
	Retrieve the descriptor of a given microslice.
const MicrosliceView	get_microslice (uint64_t component, uint64_t microslice_index) const
	Retrieve the descriptor and pointer to the data of a given microslice.

Protected Attributes
TimesliceDescriptor	timeslice_descriptor_
	The timeslice descriptor.
std::vector< uint8_t * >	data_ptr_
	A vector of pointers to the data content, one per timeslice component.
std::vector< TimesliceComponentDescriptor * >	desc_ptr_
	A vector of pointers to the microslice descriptors, one per timeslice component.

Detailed Description

The Timeslice class provides read access to the data of a timeslice.

This class is an abstract base class for all classes providing access to the contents of a single timeslice.

Definition at line 27 of file Timeslice.h.

Constructor & Destructor Documentation

~Timeslice() [1/2]

virtual fles::Timeslice::~Timeslice ( )

virtualdefault

~Timeslice() [2/2]

virtual fles::Timeslice::~Timeslice ( )

virtualdefault

Member Function Documentation

content() [1/2]

const uint8_t * fles::Timeslice::content ( uint64_t  component, uint64_t  microslice  ) const

inline

Retrieve a pointer to the data content of a given microslice.

Definition at line 45 of file Timeslice.h.

References data_ptr_, desc_ptr_, descriptor(), and fles::MicrosliceDescriptor::offset.

Referenced by fles::StorableTimeslice::append_microslice().

content() [2/2]

const uint8_t * fles::Timeslice::content ( uint64_t  component, uint64_t  microslice  ) const

inline

Retrieve a pointer to the data content of a given microslice.

Definition at line 45 of file Timeslice.h.

References data_ptr_, desc_ptr_, descriptor(), and fles::MicrosliceDescriptor::offset.

descriptor() [1/2]

const MicrosliceDescriptor & fles::Timeslice::descriptor ( uint64_t  component, uint64_t  microslice  ) const

inline

Retrieve the descriptor of a given microslice.

Definition at line 52 of file Timeslice.h.

References data_ptr_.

Referenced by fles::StorableTimeslice::append_microslice(), and content().

descriptor() [2/2]

const MicrosliceDescriptor & fles::Timeslice::descriptor ( uint64_t  component, uint64_t  microslice  ) const

inline

Retrieve the descriptor of a given microslice.

Definition at line 52 of file Timeslice.h.

References data_ptr_.

get_microslice() [1/2]

const MicrosliceView fles::Timeslice::get_microslice ( uint64_t  component, uint64_t  microslice_index  ) const

inline

Retrieve the descriptor and pointer to the data of a given microslice.

Definition at line 58 of file Timeslice.h.

References data_ptr_, desc_ptr_, and fles::MicrosliceDescriptor::offset.

get_microslice() [2/2]

const MicrosliceView fles::Timeslice::get_microslice ( uint64_t  component, uint64_t  microslice_index  ) const

inline

Retrieve the descriptor and pointer to the data of a given microslice.

Definition at line 58 of file Timeslice.h.

References data_ptr_, desc_ptr_, and fles::MicrosliceDescriptor::offset.

index() [1/2]

uint64_t fles::Timeslice::index ( ) const

inline

Retrieve the timeslice index.

Definition at line 33 of file Timeslice.h.

References fles::TimesliceDescriptor::index, and timeslice_descriptor_.

Referenced by fles::StorableTimeslice::StorableTimeslice().

index() [2/2]

uint64_t fles::Timeslice::index ( ) const

inline

Retrieve the timeslice index.

Definition at line 33 of file Timeslice.h.

References fles::TimesliceDescriptor::index, and timeslice_descriptor_.

num_components() [1/2]

uint64_t fles::Timeslice::num_components ( ) const

inline

Retrieve the number of components (contributing input channels).

Definition at line 42 of file Timeslice.h.

References fles::TimesliceDescriptor::num_components, and timeslice_descriptor_.

num_components() [2/2]

uint64_t fles::Timeslice::num_components ( ) const

inline

Retrieve the number of components (contributing input channels).

Definition at line 42 of file Timeslice.h.

References fles::TimesliceDescriptor::num_components, and timeslice_descriptor_.

num_core_microslices() [1/2]

uint64_t fles::Timeslice::num_core_microslices ( ) const

inline

Retrieve the number of core microslices.

Definition at line 36 of file Timeslice.h.

References fles::TimesliceDescriptor::num_core_microslices, and timeslice_descriptor_.

Referenced by fles::StorableTimeslice::StorableTimeslice().

num_core_microslices() [2/2]

uint64_t fles::Timeslice::num_core_microslices ( ) const

inline

Retrieve the number of core microslices.

Definition at line 36 of file Timeslice.h.

References fles::TimesliceDescriptor::num_core_microslices, and timeslice_descriptor_.

num_microslices() [1/2]

uint64_t fles::Timeslice::num_microslices ( uint64_t  component ) const

inline

Retrieve the total number of microslices.

Definition at line 39 of file Timeslice.h.

References desc_ptr_.

Referenced by fles::StorableTimeslice::append_component().

num_microslices() [2/2]

uint64_t fles::Timeslice::num_microslices ( uint64_t  component ) const

inline

Retrieve the total number of microslices.

Definition at line 39 of file Timeslice.h.

References desc_ptr_.

Member Data Documentation

data_ptr_

std::vector< uint8_t * > fles::Timeslice::data_ptr_

protected

A vector of pointers to the data content, one per timeslice component.

Definition at line 81 of file Timeslice.h.

Referenced by content(), descriptor(), and get_microslice().

desc_ptr_

std::vector< TimesliceComponentDescriptor * > fles::Timeslice::desc_ptr_

protected

A vector of pointers to the microslice descriptors, one per timeslice component.

Definition at line 85 of file Timeslice.h.

Referenced by content(), get_microslice(), and num_microslices().

timeslice_descriptor_

TimesliceDescriptor fles::Timeslice::timeslice_descriptor_

protected

The timeslice descriptor.

Definition at line 78 of file Timeslice.h.

Referenced by fles::StorableTimeslice::append_component(), fles::StorableTimeslice::append_microslice(), index(), num_components(), num_core_microslices(), and fles::StorableTimeslice::StorableTimeslice().

---

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

• decoder/fles_ipc/Timeslice.h
• install/include/Timeslice.h