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

CRC parameters. More...

#include <CRC.h>

Public Member Functions

Table< CRCType, CRCWidth > MakeTable () const
 Returns a CRC lookup table construct using these CRC parameters. More...
 

Public Attributes

CRCType finalXOR
 Value to XOR with the final CRC. More...
 
CRCType initialValue
 Initial CRC value. More...
 
CRCType polynomial
 CRC polynomial. More...
 
bool reflectInput
 true to reflect all input bytes More...
 
bool reflectOutput
 true to reflect the output CRC (reflection occurs before the final XOR) More...
 

Detailed Description

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

CRC parameters.

Member Function Documentation

◆ MakeTable()

template<typename CRCType , crcpp_uint16 CRCWidth>
CRC::Table< CRCType, CRCWidth > CRC::Parameters< CRCType, CRCWidth >::MakeTable ( ) const

Returns a CRC lookup table construct using these CRC parameters.

Note
This function primarily exists to allow use of the auto keyword instead of instantiating a table directly, since template parameters are not inferred in constructors.
Template Parameters
CRCTypeInteger type for storing the CRC result
CRCWidthNumber of bits in the CRC
Returns
CRC lookup table

Member Data Documentation

◆ finalXOR

template<typename CRCType , crcpp_uint16 CRCWidth>
CRCType CRC::Parameters< CRCType, CRCWidth >::finalXOR

Value to XOR with the final CRC.

Referenced by CRC::Calculate().

◆ initialValue

template<typename CRCType , crcpp_uint16 CRCWidth>
CRCType CRC::Parameters< CRCType, CRCWidth >::initialValue

Initial CRC value.

Referenced by CRC::Calculate().

◆ polynomial

template<typename CRCType , crcpp_uint16 CRCWidth>
CRCType CRC::Parameters< CRCType, CRCWidth >::polynomial

CRC polynomial.

◆ reflectInput

template<typename CRCType , crcpp_uint16 CRCWidth>
bool CRC::Parameters< CRCType, CRCWidth >::reflectInput

true to reflect all input bytes

Referenced by CRC::Calculate().

◆ reflectOutput

template<typename CRCType , crcpp_uint16 CRCWidth>
bool CRC::Parameters< CRCType, CRCWidth >::reflectOutput

true to reflect the output CRC (reflection occurs before the final XOR)

Referenced by CRC::Calculate().


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