Hash.hpp

Go to the documentation of this file.

// ======================================================================
// \title  Hash.hpp
// \author dinkel
// \brief  hpp file for Hash class
//
// \copyright
// Copyright 2009-2015, by the California Institute of Technology.
// ALL RIGHTS RESERVED.  United States Government Sponsorship
// acknowledged.
//
// ======================================================================

#ifndef UTILS_HASH_HPP
#define UTILS_HASH_HPP

#include <Utils/Hash/HashBuffer.hpp>
#include "Fw/Types/StringType.hpp"

namespace Utils {

class Hash {
  public:
    // ----------------------------------------------------------------------
    // Types
    // ----------------------------------------------------------------------
  public:
    // ----------------------------------------------------------------------
    // Construction and destruction
    // ----------------------------------------------------------------------

    Hash();

    ~Hash();

  public:
    // ----------------------------------------------------------------------
    // Public static methods
    // ----------------------------------------------------------------------

    static void hash(const void* data, const FwSizeType len, HashBuffer& buffer);

  public:
    // ----------------------------------------------------------------------
    // Public instance methods
    // ----------------------------------------------------------------------

    void init();

    void setHashValue(HashBuffer& value  
    );

    void update(const void* const data, const FwSizeType len);

    void final(HashBuffer& buffer  
    );

    void final(U32& hashvalue);

    static const char* getFileExtensionString();

    static void addFileExtension(const Fw::StringBase& baseName,  
                                 Fw::StringBase& extendedName     
    );

    static FwSizeType getFileExtensionLength();

  private:
    // ----------------------------------------------------------------------
    // Private member variables
    // ----------------------------------------------------------------------

    HASH_HANDLE_TYPE hash_handle;
};

}  // namespace Utils

#endif