Public Member Functions | Public Attributes | List of all members
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.

Definition at line 153 of file crc.h.

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
CRCTypeInteger type for storing the CRC result
CRCWidthNumber of bits in the CRC
Returns
CRC lookup table

Definition at line 313 of file crc.h.

Member Data Documentation

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

Value to XOR with the final CRC.

Definition at line 157 of file crc.h.

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

Initial CRC value.

Definition at line 156 of file crc.h.

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

CRC polynomial.

Definition at line 155 of file crc.h.

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

true to reflect all input bytes

Definition at line 158 of file crc.h.

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

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

Definition at line 159 of file crc.h.


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


vesc_driver
Author(s): Michael T. Boulet , Joshua Whitley
autogenerated on Sun Apr 18 2021 02:48:01