CRC::Table< CRCType, CRCWidth > Struct Template Reference

CRC lookup table. After construction, the CRC parameters are fixed. More...

#include <CRC.h>

Public Member Functions
	Table (const Parameters< CRCType, CRCWidth > &parameters)
	Constructs a CRC table from a set of CRC parameters.
const Parameters< CRCType, CRCWidth > &	GetParameters () const
	Gets the CRC parameters used to construct the CRC table.
const CRCType *	GetTable () const
	Gets the CRC table.
CRCType	operator[] (unsigned char index) const
	Gets an entry in the CRC table.

Detailed Description

template<typename CRCType, crcpp_uint16 CRCWidth>
struct CRC::Table< CRCType, CRCWidth >

CRC lookup table. After construction, the CRC parameters are fixed.

Note

A CRC table can be used for multiple CRC calculations.

Definition at line 166 of file CRC.h.

Constructor & Destructor Documentation

Table()

template<typename CRCType , crcpp_uint16 CRCWidth>

CRC::Table< CRCType, CRCWidth >::Table ( const Parameters< CRCType, CRCWidth > &  parameters )

inline

Constructs a CRC table from a set of CRC parameters.

Parameters

[in]

parameters

CRC parameters

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Definition at line 336 of file CRC.h.

Member Function Documentation

GetParameters()

template<typename CRCType , crcpp_uint16 CRCWidth>

const CRC::Parameters< CRCType, CRCWidth > & CRC::Table< CRCType, CRCWidth >::GetParameters ( ) const

inline

Gets the CRC parameters used to construct the CRC table.

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns

CRC parameters

Definition at line 361 of file CRC.h.

GetTable()

template<typename CRCType , crcpp_uint16 CRCWidth>

const CRCType * CRC::Table< CRCType, CRCWidth >::GetTable ( ) const

inline

Gets the CRC table.

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns

CRC table

Definition at line 372 of file CRC.h.

operator[]()

template<typename CRCType , crcpp_uint16 CRCWidth>

CRCType CRC::Table< CRCType, CRCWidth >::operator[] ( unsigned char  index ) const

inline

Gets an entry in the CRC table.

Parameters

[in]

index

Index into the CRC table

Template Parameters

CRCType	Integer type for storing the CRC result
CRCWidth	Number of bits in the CRC

Returns

CRC table entry

Definition at line 384 of file CRC.h.

---

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

• /home/runner/work/rogue/rogue/include/rogue/protocols/packetizer/CRC.h