SearchEngineBase.h

Go to the documentation of this file.

// Copyright (c) 2002-2023, The OpenMS Team -- EKU Tuebingen, ETH Zurich, and FU Berlin
// SPDX-License-Identifier: BSD-3-Clause
//
// --------------------------------------------------------------------------
// $Maintainer: Chris Bielow $
// $Authors: Chris Bielow $
// --------------------------------------------------------------------------
 
#pragma once
 
#include "OpenMS/METADATA/ProteinIdentification.h"
#include <OpenMS/APPLICATIONS/TOPPBase.h>
 
 
namespace OpenMS
{
  
  class OPENMS_DLLAPI SearchEngineBase : public TOPPBase
  {
  public:
    SearchEngineBase() = delete;
 
    SearchEngineBase(const SearchEngineBase&) = delete;
 
    SearchEngineBase(const String& name, const String& description, bool official = true, const std::vector<Citation>& citations = {}, bool toolhandler_test = true);
 
    ~SearchEngineBase() override;
 
    String getRawfileName(int ms_level = 2) const;
 
 
    String getDBFilename(const String& db = "") const;
 
 
    virtual void registerPeptideIndexingParameter_(Param peptide_indexing_parameter);
 
    virtual SearchEngineBase::ExitCodes reindex_(
      std::vector<ProteinIdentification>& protein_identifications, 
      std::vector<PeptideIdentification>& peptide_identifications) const;
  }; // end SearchEngineBase
 
}   // end NS OpenMS