CRC_Parameters - Man Page

CRC parameters.

Synopsis

#include <CRC.h>

Public Member Functions

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

Public Attributes

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

Detailed Description

template<typename CRCType, crcpp_uint16 CRCWidth>

struct CRC::Parameters< CRCType, CRCWidth >"CRC parameters.

Member Function Documentation

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

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

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

Returns

CRC lookup table

Member Data Documentation

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

Value to XOR with the final CRC.

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

Initial CRC value.

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

CRC polynomial.

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

true to reflect all input bytes

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

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

Author

Generated automatically by Doxygen for CRC++ from the source code.

Info

Version 1.0.1.0 CRC++