BitReader Class Reference

Description:

Reads bits from a BitBufferBase.

Definition at line 1006 of file bitbuffer.hpp.

#include <bitbuffer.hpp>

Inheritance diagram for BitReader:

Collaboration diagram for BitReader:

Public Method Index:
	BitReader (BitBufferBase &buffer)
	BitReader (BitBufferBase &buffer, const BitBufferBase::Index &index)
	~BitReader ()
template<ShiftOpRHS TWidth, typename TResult >
TResult	Read ()
template<typename TIntegral >
TIntegral	Read ()
template<typename TResult >
TResult	Read (ShiftOpRHS width)
void	Reset ()
	Resets this reader to the start of the bit buffer.
void	Reset (const BitBufferBase::Index &index)
BitReader &	Sync ()
Public Method Index: inherited from BitRWBase
BitBufferBase &	GetBuffer () const
BitBufferBase::Index	GetIndex () const
uinteger	RemainingSize () const
uinteger	Usage () const

Protected Method Index:
ALIB_API uint16_t	readUIntegral16 ()
ALIB_API uint32_t	readUIntegral32 ()
ALIB_API uint64_t	readUIntegral64 ()
ALIB_API uint8_t	readUIntegral8 ()
Protected Method Index: inherited from BitRWBase
	BitRWBase (BitBufferBase &buffer)

Private Type Index:
using	TStorage = BitBufferBase::TStorage
	Local type alias (shortcut)

Private Field Index:
BitBufferBase::TStorage	word
	The current word, which is partly read and shifted to start with current bit.

Additional Inherited Members
Protected Field Index: inherited from BitRWBase
BitBufferBase &	bb
	The bit buffer to write into. Provided on construction.
BitBufferBase::Index	idx
	The current reading/writing index within bb.

Type Definition Details:

TStorage

using TStorage = BitBufferBase::TStorage

private

Local type alias (shortcut)

Definition at line 1009 of file bitbuffer.hpp.

Field Details:

word

BitBufferBase::TStorage word

private

The current word, which is partly read and shifted to start with current bit.

Definition at line 1012 of file bitbuffer.hpp.

Constructor(s) / Destructor Details:

BitReader() [1/2]

BitReader ( BitBufferBase & buffer )

inlineexplicit

Constructs a bit reader using the given bit buffer and starting to read at the beginning.

Parameters

buffer

The buffer to read from.

Definition at line 1017 of file bitbuffer.hpp.

BitReader() [2/2]

BitReader ( BitBufferBase & buffer, const BitBufferBase::Index & index )

inlineexplicit

Constructs a bit reader using the given bit buffer, starting to read at the given Index.

Parameters

buffer	The buffer to read from.
index	An index providing the postion of the first bit to read in buffer.

Definition at line 1028 of file bitbuffer.hpp.

~BitReader()

~BitReader ( )

inline

Destructs a bit reader. In debug compilations an ALib assertion is raised if the a read operation passed the end of the underlying buffer was performed.

Definition at line 1038 of file bitbuffer.hpp.

Method Details:

Read() [1/3]

template<ShiftOpRHS TWidth, typename TResult >

TResult Read

(

)

Reads the given number of bits from the stream into the given unsigned integral value.

Note

Internally, different template functions selected with std::enable_if are selected for the different integral types.

See also

This method uses a template parameter for the number of bits to read. A slightly slower, non-templated version is available with Read<TResult>(ShiftOpRHS), which is to be used when the number of bits to write is determined only at run-time.

Template Parameters

TWidth	The number of bits in val to write.
TResult	The type of the value to return.

Returns

The value read.

Read() [2/3]

template<typename TIntegral >

TIntegral Read

(

)

Reads the given integral value from the stream. Information about the encoding of the values is given with the documentation of BitWriter::Write<TIntegral>(TIntegral).

Returns

The value read from the bit buffer.

Read() [3/3]

template<typename TResult >

TResult Read

(

ShiftOpRHS

width

)

Reads the given number of bits from tif( )he stream into the given unsigned integral value.

Note

Internally, different template functions selected with std::enable_if are selected for different integral types.

See also

A method that uses a template parameter for the number of bits to read, is is available with Read<TWidth,TResult>if( ) (TIntegral). This might be slightly faster and should be used instead of this method, whenever the number of bits to read is known at compilation time.

Template Parameters

TResult

The type of the value to return. Defaults to type int.

Parameters

width

The number of bits to read.

Returns

The value read.

readUIntegral16()

uint16_t readUIntegral16 ( )

protected

Internal method that reads a unsigned 16-bit value.

Returns

The value read.

Definition at line 255 of file bitbuffer.cpp.

Here is the call graph for this function:

readUIntegral32()

uint32_t readUIntegral32 ( )

protected

Internal method that reads a unsigned 32-bit value.

Returns

The value read.

Definition at line 265 of file bitbuffer.cpp.

Here is the call graph for this function:

readUIntegral64()

uint64_t readUIntegral64 ( )

protected

Internal method that reads a unsigned 64-bit value.

Returns

The value read.

Definition at line 277 of file bitbuffer.cpp.

Here is the call graph for this function:

readUIntegral8()

uint8_t readUIntegral8 ( )

protected

Internal method that reads a unsigned 8-bit value.

Returns

The value read.

Definition at line 245 of file bitbuffer.cpp.

Here is the call graph for this function:

Reset() [1/2]

void Reset ( )

inline

Resets this reader to the start of the bit buffer.

Definition at line 1045 of file bitbuffer.hpp.

Reset() [2/2]

void Reset ( const BitBufferBase::Index & index )

inline

Resets this reader to the given index position and calls Sync().

Parameters

index

The next read position.

Definition at line 1054 of file bitbuffer.hpp.

Sync()

BitReader & Sync ( )

inline

Re-reads the currently fetched storage word from the memory.

Note

This method is not needed in common use cases and implemented solely for the purpose to support unit-tests which write and write in parallel to the same bit buffer.

Returns

A reference to this BitReader to allow concatenated operations.

Definition at line 1066 of file bitbuffer.hpp.

---

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

• bitbuffer.hpp
• bitbuffer.cpp