SourceFile.h

Go to the documentation of this file.

// Copyright (c) 2002-present, OpenMS Inc. -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Timo Sachsenberg $
// $Authors: Marc Sturm $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/METADATA/CVTermList.h>
#include <OpenMS/DATASTRUCTURES/ListUtils.h>
 
namespace OpenMS
{
  class OPENMS_DLLAPI SourceFile :
    public CVTermList
  {
public:
    enum class ChecksumType
    {
      UNKNOWN_CHECKSUM, 
      SHA1, 
      MD5, 
      SIZE_OF_CHECKSUMTYPE
    };
 
    static const std::string NamesOfChecksumType[static_cast<size_t>(ChecksumType::SIZE_OF_CHECKSUMTYPE)];
 
    static StringList getAllNamesOfChecksumType();
 
    SourceFile();
    SourceFile(const SourceFile&) = default;
    SourceFile(SourceFile&&) = default;
    ~SourceFile() override;
 
    SourceFile& operator=(const SourceFile&) = default;
    SourceFile& operator=(SourceFile&&) = default;
 
    bool operator==(const SourceFile& rhs) const;
    bool operator!=(const SourceFile& rhs) const;
 
    const std::string& getNameOfFile() const;
    void setNameOfFile(const std::string& name_of_file);
 
    const std::string& getPathToFile() const;
    void setPathToFile(const std::string& path_path_to_file);
 
    float getFileSize() const;
    void setFileSize(float file_size);
 
    const std::string& getFileType() const;
    void setFileType(const std::string& file_type);
 
    const std::string& getChecksum() const;
    void setChecksum(const std::string& checksum, ChecksumType type);
    ChecksumType getChecksumType() const;
 
    const std::string& getNativeIDType() const;
    void setNativeIDType(const std::string& type);
 
    const std::string& getNativeIDTypeAccession() const;
    void setNativeIDTypeAccession(const std::string& accesssion);
 
protected:
    std::string name_of_file_;
    std::string path_to_file_;
    double file_size_;
    std::string file_type_;
    std::string checksum_;
    ChecksumType checksum_type_ = SourceFile::ChecksumType::UNKNOWN_CHECKSUM;
    std::string native_id_type_;
    std::string native_id_type_accession_;
  };
} // namespace OpenMS