ckvalue.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_CKVALUE_HPP_FD0D3DA3_A3D6_4C78_BC24_3ED4A5CD585E
#define INC_CKVALUE_HPP_FD0D3DA3_A3D6_4C78_BC24_3ED4A5CD585E
 
//---------------------------------------------------------------------------
// #include <string>  // already included in "libxcks/checksum.hpp"
// #include <vector>  // already included in "libxcks/types.hpp"
 
#include "libxcks/export.hpp"
#include "libxcks/checksum.hpp"
#include "libxcks/types.hpp"
//---------------------------------------------------------------------------
 
 
namespace libxcks
{
class LIBXCKS_SO_EXPORT ChecksumValue
{
 protected:
  uint8_t*       value;      
  size_t         valueSize;  
  ChecksumAlgoId type;       
 
  // Clones the source instance in this instance.
  void clone(const ChecksumValue& source);
 
 public:
  // Constructor.
  ChecksumValue();
 
  // Constructor with a checksum's value.
  ChecksumValue(const uint8_t* value, const size_t size, const ChecksumAlgoId type);
 
  // Constructor with a checksum's value.
  ChecksumValue(const std::string& strValue, const ChecksumAlgoId type);
 
  // Constructor from a checksum's value.
  ChecksumValue(const Checksum& checksum);
 
  // Copy constructor.
  ChecksumValue(const ChecksumValue& source);
 
  // Move constructor.
  ChecksumValue(ChecksumValue&& rhs);
 
  // Assignment operator.
  ChecksumValue& operator=(const ChecksumValue& source);
 
  // Move assignment operator.
  ChecksumValue& operator=(ChecksumValue&& rhs);
 
  // Destructor.
  virtual ~ChecksumValue();
 
  // Tests if two checksum's values are equals.
  bool operator==(const ChecksumValue& cmp) const;
 
  // Tests if two checksum's values are different.
  bool operator!=(const ChecksumValue& cmp) const;
 
  // Compares this value with the value of another checksum.
  int compare(const ChecksumValue& cmp) const;
 
  // Gets the value of the checksum.
  const uint8_t* getValue() const;
 
  // Gets the value of the checksum.
  bool getValue(uint8_t* value, const size_t size) const;
 
  // Sets the value of the checksum.
  void setValue(const uint8_t* value, const size_t size, const ChecksumAlgoId type);
 
  // Sets the value of the checksum.
  void setValue(const std::string& strValue, const ChecksumAlgoId type);
 
  // Gets the size of the checksum's value.
  size_t getSize() const;
 
  // Gets the type of the checksum.
  ChecksumAlgoId getType() const;
};
//---------------------------------------------------------------------------
 
 
using ArrayChecksumValue = std::vector<ChecksumValue>;
 
 
//###########################################################################
// Helper functions
//###########################################################################
 
// Checks if the array as a value of the given type.
bool LIBXCKS_SO_EXPORT hasChecksumValueWithAlgoId(const ArrayChecksumValue& ckvalues, const ChecksumAlgoId type);
//---------------------------------------------------------------------------
 
// Gets a set of null checksums' values from a set of checksums ids.
void LIBXCKS_SO_EXPORT getNullValues(ArrayChecksumValue& values, const ArrayChecksumAlgoId& ids);
//---------------------------------------------------------------------------
 
}  // namespace libxcks
//---------------------------------------------------------------------------
 
#endif  // INC_CKVALUE_HPP_FD0D3DA3_A3D6_4C78_BC24_3ED4A5CD585E