BitStreamWriter< OStream > Class Template Reference

#include <streams.h>

Public Member Functions
	BitStreamWriter (OStream &ostream)
	~BitStreamWriter ()
void	Write (uint64_t data, int nbits)
void	Flush ()

Private Attributes
OStream &	m_ostream
uint8_t	m_buffer {0}
int	m_offset {0}

Constructor & Destructor Documentation

BitStreamWriter()

template<typename OStream >

BitStreamWriter< OStream >::BitStreamWriter ( OStream &  ostream )

inlineexplicit

~BitStreamWriter()

template<typename OStream >

BitStreamWriter< OStream >::~BitStreamWriter ( )

inline

Member Function Documentation

Flush()

template<typename OStream >

void BitStreamWriter< OStream >::Flush ( )

inline

Flush any unwritten bits to the output stream, padding with 0's to the next byte boundary.

Write()

template<typename OStream >

void BitStreamWriter< OStream >::Write ( uint64_t  data, int  nbits  )

inline

Write the nbits least significant bits of a 64-bit int to the output stream. Data is buffered until it completes an octet.

Member Data Documentation

m_buffer

template<typename OStream >

uint8_t BitStreamWriter< OStream >::m_buffer {0}

private

Buffered byte waiting to be written to the output stream. The byte is written buffer when m_offset reaches 8 or Flush() is called.

m_offset

template<typename OStream >

int BitStreamWriter< OStream >::m_offset {0}

private

Number of high order bits in m_buffer already written by previous Write() calls and not yet flushed to the stream. The next bit to be written to is at this offset from the most significant bit position.

m_ostream

template<typename OStream >

OStream& BitStreamWriter< OStream >::m_ostream

private

---

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

• src/streams.h