PeptideEvidence.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: Timo Sachsenberg $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/CONCEPT/Types.h>
#include <OpenMS/CONCEPT/HashUtils.h>
#include <OpenMS/DATASTRUCTURES/String.h>
 
#include <functional>
 
namespace OpenMS
{
 
  class OPENMS_DLLAPI PeptideEvidence
  {
public:
    static const int UNKNOWN_POSITION; // == -1
 
    // Note: we use 0 as position of the N-terminus while e.g. mzTab or other formats start counting at 1.
    static const int N_TERMINAL_POSITION;
    static const char UNKNOWN_AA; // PeptideEvidence::UNKNOWN_AA = 'X';
 
    // Note: we use '[' and ']' instead of  e.g. '-' as in mzTab specification
    static const char N_TERMINAL_AA;
    static const char C_TERMINAL_AA;
 
    PeptideEvidence();
 
    explicit PeptideEvidence(const String& accession, Int start=UNKNOWN_POSITION, Int end=UNKNOWN_POSITION, char aa_before=UNKNOWN_AA, char aa_after=UNKNOWN_AA);
 
    PeptideEvidence(const PeptideEvidence&) = default;
 
    PeptideEvidence(PeptideEvidence&&) noexcept = default;
 
    ~PeptideEvidence() = default;
 
    PeptideEvidence& operator=(const PeptideEvidence&) = default;
    PeptideEvidence& operator=(PeptideEvidence&&) = default; // TODO: add noexcept (gcc 4.8 bug)
 
    bool operator==(const PeptideEvidence& rhs) const;
    
    bool operator<(const PeptideEvidence& rhs) const;
 
    bool operator!=(const PeptideEvidence& rhs) const;
 
    bool hasValidLimits() const;
 
    const String& getProteinAccession() const;
 
    void setProteinAccession(const String& s);
 
    void setStart(const Int a);
 
    Int getStart() const;
 
    void setEnd(const Int a);
 
    Int getEnd() const;
 
    void setAABefore(const char acid);
 
    char getAABefore() const;
 
    void setAAAfter(const char acid);
 
    char getAAAfter() const;
 
protected:
    String accession_;
 
    Int start_;
 
    Int end_;
 
    char aa_before_;
 
    char aa_after_;
  };
 
} // namespace OpenMS
 
// Hash function specialization for PeptideEvidence
namespace std
{
  template<>
  struct hash<OpenMS::PeptideEvidence>
  {
    std::size_t operator()(const OpenMS::PeptideEvidence& pe) const noexcept
    {
      std::size_t seed = OpenMS::fnv1a_hash_string(pe.getProteinAccession());
      OpenMS::hash_combine(seed, OpenMS::hash_int(pe.getStart()));
      OpenMS::hash_combine(seed, OpenMS::hash_int(pe.getEnd()));
      OpenMS::hash_combine(seed, OpenMS::hash_int(static_cast<int>(pe.getAABefore())));
      OpenMS::hash_combine(seed, OpenMS::hash_int(static_cast<int>(pe.getAAAfter())));
      return seed;
    }
  };
}