ScoredProcessingResult.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: Hendrik Weisser $
// $Authors: Hendrik Weisser $
// --------------------------------------------------------------------------
 
#pragma once
 
#include <OpenMS/METADATA/ID/AppliedProcessingStep.h>
#include <map>
#include <optional>
#include <tuple>
#include <utility>
 
namespace OpenMS
{
  namespace IdentificationDataInternal
  {
    struct OPENMS_DLLAPI ScoredProcessingResult: public MetaInfoInterface
    {
      AppliedProcessingSteps steps_and_scores;
 
      AppliedProcessingSteps::OrderedView getStepsAndScoresByStep()
      {
        return steps_and_scores.get<1>();
      }
 
      AppliedProcessingSteps::ConstOrderedView getStepsAndScoresByStep() const
      {
        return steps_and_scores.get<1>();
      }
 
      void addProcessingStep(const AppliedProcessingStep& step);
 
      void addProcessingStep(ProcessingStepRef step_ref,
                             const std::map<ScoreTypeRef, double>& scores =
                             std::map<ScoreTypeRef, double>());
 
      void addScore(ScoreTypeRef score_type, double score,
                    const std::optional<ProcessingStepRef>&
                    processing_step_opt = std::nullopt);
 
      ScoredProcessingResult& merge(const ScoredProcessingResult& other);
 
      std::pair<double, bool> getScore(ScoreTypeRef score_ref) const;
 
      std::pair<double, bool> getScore(ScoreTypeRef score_ref,
                                       std::optional<ProcessingStepRef>
                                       processing_step_opt) const;
 
      std::tuple<double, std::optional<ProcessingStepRef>, bool>
      getScoreAndStep(ScoreTypeRef score_ref) const;
 
      std::tuple<double, std::optional<ScoreTypeRef>, bool>
      getMostRecentScore() const;
 
      Size getNumberOfScores() const;
 
    protected:
      explicit ScoredProcessingResult(
        const AppliedProcessingSteps& steps_and_scores =
        AppliedProcessingSteps()):
        steps_and_scores(steps_and_scores)
      {
      }
 
      ScoredProcessingResult(const ScoredProcessingResult&) = default;
    };
 
  }
}