The StorableTimeslice class contains the data of a single timeslice. More...

#include <StorableTimeslice.h>

Inheritance diagram for fles::StorableTimeslice:

Collaboration diagram for fles::StorableTimeslice:

Public Member Functions
	StorableTimeslice ()

	StorableTimeslice (const StorableTimeslice &ts)
	Copy constructor.

	StorableTimeslice (StorableTimeslice &&ts) noexcept
	Delete assignment operator (not implemented).

	StorableTimeslice (uint32_t num_core_microslices, uint64_t index=UINT64_MAX, uint64_t ts_pos=UINT64_MAX)
	Construct and initialize empty timeslice to fill using append_component.

uint32_t	append_component (uint64_t num_microslices, uint64_t=0)
	Append a single component to fill using append_microslice.

uint64_t	append_microslice (uint32_t component, uint64_t microslice, MicrosliceDescriptor descriptor, const uint8_t *content)
	Append a single microslice using given descriptor and content.

uint64_t	append_microslice (uint32_t component, uint64_t microslice, StorableMicroslice &m)
	Append a single microslice object.

	StorableTimeslice ()

	StorableTimeslice (const StorableTimeslice &ts)
	Copy constructor.

	StorableTimeslice (StorableTimeslice &&ts) noexcept
	Delete assignment operator (not implemented).

	StorableTimeslice (uint32_t num_core_microslices, uint64_t index=UINT64_MAX, uint64_t ts_pos=UINT64_MAX)
	Construct and initialize empty timeslice to fill using append_component.

uint32_t	append_component (uint64_t num_microslices, uint64_t=0)
	Append a single component to fill using append_microslice.

uint64_t	append_microslice (uint32_t component, uint64_t microslice, MicrosliceDescriptor descriptor, const uint8_t *content)
	Append a single microslice using given descriptor and content.

uint64_t	append_microslice (uint32_t component, uint64_t microslice, StorableMicroslice &m)
	Append a single microslice object.

Public Member Functions inherited from fles::Timeslice
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.

Friends
class	boost::serialization::access

class	InputArchive< Timeslice, StorableTimeslice, ArchiveType::TimesliceArchive >

class	InputArchiveLoop< Timeslice, StorableTimeslice, ArchiveType::TimesliceArchive >

class	TimesliceSubscriber

Additional Inherited Members
Protected Attributes inherited from fles::Timeslice
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 StorableTimeslice class contains the data of a single timeslice.

Definition at line 34 of file StorableTimeslice.h.

Constructor & Destructor Documentation

◆ StorableTimeslice() [1/8]

fles::StorableTimeslice::StorableTimeslice ( )

Definition at line 39 of file StorableTimeslice.cxx.

◆ StorableTimeslice() [2/8]

fles::StorableTimeslice::StorableTimeslice ( const StorableTimeslice & ts )

Copy constructor.

Definition at line 8 of file StorableTimeslice.cxx.

◆ StorableTimeslice() [3/8]

fles::StorableTimeslice::StorableTimeslice ( StorableTimeslice && ts )

noexcept

Delete assignment operator (not implemented).

Move constructor.

Definition at line 16 of file StorableTimeslice.cxx.

◆ StorableTimeslice() [4/8]

fles::StorableTimeslice::StorableTimeslice	(	uint32_t	num_core_microslices,
		uint64_t	index = `UINT64_MAX`,
		uint64_t	ts_pos = `UINT64_MAX`
	)

inlineexplicit

Construct and initialize empty timeslice to fill using append_component.

Definition at line 49 of file StorableTimeslice.h.

References fles::Timeslice::index(), fles::TimesliceDescriptor::index, fles::TimesliceDescriptor::num_components, fles::Timeslice::num_core_microslices(), fles::TimesliceDescriptor::num_core_microslices, fles::Timeslice::timeslice_descriptor_, and fles::TimesliceDescriptor::ts_pos.

◆ StorableTimeslice() [5/8]

fles::StorableTimeslice::StorableTimeslice ( )

◆ StorableTimeslice() [6/8]

fles::StorableTimeslice::StorableTimeslice ( const StorableTimeslice & ts )

Copy constructor.

◆ StorableTimeslice() [7/8]

fles::StorableTimeslice::StorableTimeslice ( StorableTimeslice && ts )

noexcept

Delete assignment operator (not implemented).

Move constructor.

◆ StorableTimeslice() [8/8]

fles::StorableTimeslice::StorableTimeslice	(	uint32_t	num_core_microslices,
		uint64_t	index = `UINT64_MAX`,
		uint64_t	ts_pos = `UINT64_MAX`
	)

inlineexplicit

Construct and initialize empty timeslice to fill using append_component.

Definition at line 49 of file StorableTimeslice.h.

References fles::Timeslice::index(), fles::TimesliceDescriptor::index, fles::TimesliceDescriptor::num_components, fles::Timeslice::num_core_microslices(), fles::TimesliceDescriptor::num_core_microslices, fles::Timeslice::timeslice_descriptor_, and fles::TimesliceDescriptor::ts_pos.

Member Function Documentation

◆ append_component() [1/2]

uint32_t fles::StorableTimeslice::append_component	(	uint64_t	num_microslices,
		uint64_t	= `0`
	)

inline

Append a single component to fill using append_microslice.

Definition at line 58 of file StorableTimeslice.h.

References fles::TimesliceDescriptor::index, m, fles::TimesliceDescriptor::num_components, fles::Timeslice::num_microslices(), fles::TimesliceComponentDescriptor::num_microslices, fles::TimesliceComponentDescriptor::offset, fles::TimesliceComponentDescriptor::size, fles::Timeslice::timeslice_descriptor_, and fles::TimesliceComponentDescriptor::ts_num.

◆ append_component() [2/2]

uint32_t fles::StorableTimeslice::append_component	(	uint64_t	num_microslices,
		uint64_t	= `0`
	)

inline

Append a single component to fill using append_microslice.

Definition at line 58 of file StorableTimeslice.h.

References fles::TimesliceDescriptor::index, m, fles::TimesliceDescriptor::num_components, fles::Timeslice::num_microslices(), fles::TimesliceComponentDescriptor::num_microslices, fles::TimesliceComponentDescriptor::offset, fles::TimesliceComponentDescriptor::size, fles::Timeslice::timeslice_descriptor_, and fles::TimesliceComponentDescriptor::ts_num.

◆ append_microslice() [1/4]

uint64_t fles::StorableTimeslice::append_microslice	(	uint32_t	component,
		uint64_t	microslice,
		MicrosliceDescriptor	descriptor,
		const uint8_t *	content
	)

inline

Append a single microslice using given descriptor and content.

Definition at line 82 of file StorableTimeslice.h.

References fles::Timeslice::content(), fles::Timeslice::descriptor(), fles::TimesliceDescriptor::num_components, fles::TimesliceComponentDescriptor::num_microslices, fles::MicrosliceDescriptor::offset, fles::MicrosliceDescriptor::size, fles::TimesliceComponentDescriptor::size, and fles::Timeslice::timeslice_descriptor_.

Referenced by append_microslice().

◆ append_microslice() [2/4]

uint64_t fles::StorableTimeslice::append_microslice	(	uint32_t	component,
		uint64_t	microslice,
		MicrosliceDescriptor	descriptor,
		const uint8_t *	content
	)

inline

Append a single microslice using given descriptor and content.

Definition at line 82 of file StorableTimeslice.h.

References fles::Timeslice::content(), fles::Timeslice::descriptor(), fles::TimesliceDescriptor::num_components, fles::TimesliceComponentDescriptor::num_microslices, fles::MicrosliceDescriptor::offset, fles::MicrosliceDescriptor::size, fles::TimesliceComponentDescriptor::size, and fles::Timeslice::timeslice_descriptor_.

◆ append_microslice() [3/4]

uint64_t fles::StorableTimeslice::append_microslice	(	uint32_t	component,
		uint64_t	microslice,
		StorableMicroslice &	m
	)

inline

Append a single microslice object.

Definition at line 112 of file StorableTimeslice.h.

References append_microslice(), and m.

◆ append_microslice() [4/4]

uint64_t fles::StorableTimeslice::append_microslice	(	uint32_t	component,
		uint64_t	microslice,
		StorableMicroslice &	m
	)

inline

Append a single microslice object.

Definition at line 112 of file StorableTimeslice.h.

References append_microslice(), and m.

Friends And Related Symbol Documentation

◆ boost::serialization::access

boost::serialization::access

friend

Definition at line 118 of file StorableTimeslice.h.

◆ InputArchive< Timeslice, StorableTimeslice, ArchiveType::TimesliceArchive >

friend class InputArchive< Timeslice, StorableTimeslice, ArchiveType::TimesliceArchive >

friend

Definition at line 118 of file StorableTimeslice.h.

◆ InputArchiveLoop< Timeslice, StorableTimeslice, ArchiveType::TimesliceArchive >

friend class InputArchiveLoop< Timeslice, StorableTimeslice, ArchiveType::TimesliceArchive >

friend

Definition at line 118 of file StorableTimeslice.h.

◆ TimesliceSubscriber

TimesliceSubscriber

friend

Definition at line 121 of file StorableTimeslice.h.

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

decoder/fles_ipc/StorableTimeslice.h
install/include/StorableTimeslice.h
decoder/fles_ipc/StorableTimeslice.cxx

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StorableTimeslice() [1/8]

◆ StorableTimeslice() [2/8]

◆ StorableTimeslice() [3/8]

◆ StorableTimeslice() [4/8]

◆ StorableTimeslice() [5/8]

◆ StorableTimeslice() [6/8]

◆ StorableTimeslice() [7/8]

◆ StorableTimeslice() [8/8]

Member Function Documentation

◆ append_component() [1/2]

◆ append_component() [2/2]

◆ append_microslice() [1/4]

◆ append_microslice() [2/4]

◆ append_microslice() [3/4]

◆ append_microslice() [4/4]

Friends And Related Symbol Documentation

◆ boost::serialization::access

◆ InputArchive< Timeslice, StorableTimeslice, ArchiveType::TimesliceArchive >

◆ InputArchiveLoop< Timeslice, StorableTimeslice, ArchiveType::TimesliceArchive >

◆ TimesliceSubscriber