CxxUtils::BitPacker< STREAM > Class Template Reference

Pack a set of values bitwise into a stream. More...

#include <BitPacker.h>

Collaboration diagram for CxxUtils::BitPacker< STREAM >:

Public Member Functions
	BitPacker (uint8_t nbits, STREAM &stream)
	Constructor. More...
	~BitPacker ()
	Destructor. More...
void	pack (uint32_t x)
	Pack one value to the stream. More...

Private Attributes
uint32_t	m_buf
	Buffer for the current words being packed. More...
uint8_t	m_nbuf
	Number of valid bits currently buffered. More...
uint8_t	m_nbits
	Number of bits to use for each item. More...
STREAM &	m_stream
	The output stream. More...

Detailed Description

template<class STREAM>
class CxxUtils::BitPacker< STREAM >

Pack a set of values bitwise into a stream.

This helper can be used to pack a set of values into 32-bit words and write them to a stream. The number of bits taken by each value is configurable.

STREAM should support output (operator<<) with uint32_t (satisfied by a ROOT TBuffer).

Definition at line 38 of file BitPacker.h.

Constructor & Destructor Documentation

BitPacker()

template<class STREAM >

CxxUtils::BitPacker< STREAM >::BitPacker	(	uint8_t	nbits,
		STREAM &	stream
	)

Constructor.

Parameters

nbits	Number of bits per item to use in the packed representation.
stream	Output stream object.

~BitPacker()

template<class STREAM >

CxxUtils::BitPacker< STREAM >::~BitPacker

(

)

Destructor.

This may flush buffered data to the output stream.

Member Function Documentation

pack()

template<class STREAM >

void CxxUtils::BitPacker< STREAM >::pack

(

uint32_t

x

)

Pack one value to the stream.

Parameters

x	The value to pack. The upper bits should all be clear.

Member Data Documentation

m_buf

template<class STREAM >

uint32_t CxxUtils::BitPacker< STREAM >::m_buf

private

Buffer for the current words being packed.

Definition at line 67 of file BitPacker.h.

m_nbits

template<class STREAM >

uint8_t CxxUtils::BitPacker< STREAM >::m_nbits

private

Number of bits to use for each item.

Definition at line 73 of file BitPacker.h.

m_nbuf

template<class STREAM >

uint8_t CxxUtils::BitPacker< STREAM >::m_nbuf

private

Number of valid bits currently buffered.

Definition at line 70 of file BitPacker.h.

m_stream

template<class STREAM >

STREAM& CxxUtils::BitPacker< STREAM >::m_stream

private

The output stream.

Definition at line 76 of file BitPacker.h.

---

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

• BitPacker.h