Cpl::Checksum::Api16 Class Reference

This class provides an interface for calculate a 16 bit wide Checksum. More...

Detailed Description

This class provides an interface for calculate a 16 bit wide Checksum.

The specific of the checksum is determine by the concrete class implementing this interface.

How to generate a Checksum:

1. Call reset() initialize the Checksum
2. Call accumulate() method for every byte being Checksum'd
3. Call finalize() to get the CRC value. The method can optionally appended the CRC to the buffer being Checksum'd

How to verify a Checksum:

1. Call reset() initialize the Checksum
2. Call accumulate() method for every byte being Checksum'd INCLUDING the previously generated Checksum bytes.
3. Call isOk() which returns true if the buffer passes the Checksum check.

#include <Api16.h>

Inheritance diagram for Cpl::Checksum::Api16:

Public Member Functions
virtual void	reset (void) noexcept=0
	Used to re-use/restart the Checksum object.
virtual void	accumulate (const void *bytes, unsigned numbytes=1) noexcept=0
	Call the method for every byte being Checksum'd.
virtual uint16_t	finalize (void *destBuffer=0) noexcept=0
	Call this method to finalize the Checksum.
virtual bool	isOkay (void) noexcept=0
	This method returns true if the data and the incoming Checksum bytes, that accumulate() has been called on, is good.
	~Api16 ()
	Virtual destructor.

Constructor & Destructor Documentation

~Api16()

Cpl::Checksum::Api16::~Api16 ( )

inline

Virtual destructor.

Member Function Documentation

accumulate()

virtual void Cpl::Checksum::Api16::accumulate ( const void *  bytes, unsigned  numbytes = 1  )

pure virtualnoexcept

Call the method for every byte being Checksum'd.

Implemented in Cpl::Checksum::Crc16CcittFast, and Cpl::Checksum::Fletcher16.

finalize()

virtual uint16_t Cpl::Checksum::Api16::finalize ( void *  destBuffer = 0 )

pure virtualnoexcept

Call this method to finalize the Checksum.

The calculated Checksum value is returned. If 'destBuffer' is NOT null, then the Checksum value is appended to the buffer starting at the address specified by 'destBuffer'. Note: the application is responsible for ensure there is sufficient space (and additional 2 bytes) for the appended Checksum value.

Implemented in Cpl::Checksum::Crc16CcittFast, and Cpl::Checksum::Fletcher16.

isOkay()

virtual bool Cpl::Checksum::Api16::isOkay ( void  )

pure virtualnoexcept

This method returns true if the data and the incoming Checksum bytes, that accumulate() has been called on, is good.

Returns true if the Checksum check passes; else false is returned

Implemented in Cpl::Checksum::Crc16CcittFast, and Cpl::Checksum::Fletcher16.

reset()

virtual void Cpl::Checksum::Api16::reset ( void  )

pure virtualnoexcept

Used to re-use/restart the Checksum object.

Implemented in Cpl::Checksum::Crc16CcittFast, and Cpl::Checksum::Fletcher16.

---

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

• Cpl/Checksum/Api16.h