AppliedProcessingStep Struct Reference

#include <OpenMS/METADATA/ID/AppliedProcessingStep.h>

Public Member Functions
	AppliedProcessingStep (const std::optional< ProcessingStepRef > &processing_step_opt=std::nullopt, const std::map< ScoreTypeRef, double > &scores=std::map< ScoreTypeRef, double >())
	Constructor.
bool	operator== (const AppliedProcessingStep &other) const
	Equality operator (needed for multi-index container)
std::vector< std::pair< ScoreTypeRef, double > >	getScoresInOrder (bool primary_only=false) const
	Return scores in order of priority (primary first).

Public Attributes
std::optional< ProcessingStepRef >	processing_step_opt
	(Optional) reference to the processing step
std::map< ScoreTypeRef, double >	scores
	Map of scores and their types.

Detailed Description

A processing step that was applied to a data item, possibly with associated scores.

Constructor & Destructor Documentation

AppliedProcessingStep()

AppliedProcessingStep ( const std::optional< ProcessingStepRef > &  processing_step_opt = std::nullopt, const std::map< ScoreTypeRef, double > &  scores = std::map<ScoreTypeRef, double>()  )

inlineexplicit

Constructor.

Member Function Documentation

getScoresInOrder()

std::vector< std::pair< ScoreTypeRef, double > > getScoresInOrder

(

bool

primary_only = false

)

const

Return scores in order of priority (primary first).

The order is defined in the ProcessingSoftware referenced by the processing step (if available). Scores not listed there are included at the end of the output.

Parameters

[in]

primary_only

Only return the primary score (ignoring any others)?

operator==()

bool operator==

(

const AppliedProcessingStep &

other

)

const

Equality operator (needed for multi-index container)

Member Data Documentation

processing_step_opt

std::optional<ProcessingStepRef> processing_step_opt

(Optional) reference to the processing step

If there are only scores, the processing step may be missing.

scores

std::map<ScoreTypeRef, double> scores

Map of scores and their types.