Checksum.hpp

Go to the documentation of this file.

// ======================================================================
// \title  CFDP/Checksum/Checksum.hpp
// \author bocchino
// \brief  hpp file for CFDP checksum class
//
// \copyright
// Copyright 2009-2016, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef CFDP_Checksum_HPP
#define CFDP_Checksum_HPP

#include <FpConfig.hpp>

namespace CFDP {

  class Checksum {

    public:

      // ----------------------------------------------------------------------
      // Types
      // ----------------------------------------------------------------------

    public:

      // ----------------------------------------------------------------------
      // Construction and destruction
      // ----------------------------------------------------------------------

      Checksum();

      Checksum(const U32 value);

      Checksum(const Checksum &original);

      ~Checksum();

    public:

      // ----------------------------------------------------------------------
      // Public instance methods
      // ----------------------------------------------------------------------

      Checksum& operator=(const Checksum& checksum);

      bool operator==(const Checksum& checksum) const;

      bool operator!=(const Checksum& checksum) const;

      void update(const U8* const data,  
                  const U32 offset,      
                  const U32 length       
      );

      U32 getValue() const;

    PRIVATE:

      // ----------------------------------------------------------------------
      // Private instance methods
      // ----------------------------------------------------------------------

      void addWordAligned(
          const U8 *const word 
      );

      void addWordUnaligned(
          const U8 *const word, 
          const U8 position, 
          const U8 length 
      );

      void addByteAtOffset(
          const U8 byte, 
          const U8 offset 
      );

    PRIVATE:

      // ----------------------------------------------------------------------
      // Private member variables
      // ----------------------------------------------------------------------

      U32 m_value;

    };

}

#endif