checksum.hpp

Go to the documentation of this file.

/*
 * libxcks
 * Copyright (C) 2022 Julien Couot
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef INC_CHECKSUM_HPP_BA2B9BF9_F9EA_43FB_8766_A19F518D1864
#define INC_CHECKSUM_HPP_BA2B9BF9_F9EA_43FB_8766_A19F518D1864
 
//---------------------------------------------------------------------------
// #include <string>  // included in libxcks/types.hpp
#include <cstdint>
 
#include "libxcks/export.hpp"
#include "libxcks/types.hpp"
//---------------------------------------------------------------------------
 
 
namespace libxcks
{
class LIBXCKS_SO_EXPORT Checksum
{
 public:
  virtual ~Checksum() {}
 
 
  virtual void reset() = 0;
 
  virtual std::string toString(const bool hexInUpperCase = false) const = 0;
 
  virtual uint8_t* getValue(uint8_t* buffer) const = 0;
 
  virtual size_t getSize() const = 0;
 
  virtual void update(const uint8_t* buf, size_t len) = 0;
 
  virtual std::string getName() const = 0;
 
  virtual ArrayString getAltNames() const
  {
    return ArrayString();
  }
 
  virtual ChecksumAlgoId getID() const = 0;
 
  static ArrayString getAlternativeNames()
  {
    return ArrayString();
  }
};
//---------------------------------------------------------------------------
}  // namespace libxcks
//---------------------------------------------------------------------------
 
#endif  // INC_CHECKSUM_HPP_BA2B9BF9_F9EA_43FB_8766_A19F518D1864