| OpenMS 2.5.0

Public Member Functions | Public Attributes | List of all members
IdentifiedSequence< SeqType > Struct Template Reference

Identified sequence (peptide or oligonucleotide) More...

`#include <OpenMS/METADATA/ID/IdentifiedSequence.h>`

Inheritance diagram for IdentifiedSequence< SeqType >:

## Public Member Functions

| IdentifiedSequence (const SeqType &sequence, const ParentMatches &parent_matches=ParentMatches(), const AppliedProcessingSteps &steps_and_scores=AppliedProcessingSteps())
| IdentifiedSequence (const IdentifiedSequence &other)=default
IdentifiedSequence & | operator+= (const IdentifiedSequence &other)
bool | allParentsAreDecoys () const
Public Member Functions inherited from ScoredProcessingResult
AppliedProcessingSteps::nth_index< 1 >::type & | getStepsAndScoresByStep ()
| Return the applied processing steps (incl. scores) as a set ordered by processing step reference (option) More...
const AppliedProcessingSteps::nth_index< 1 >::type & | getStepsAndScoresByStep () const
| Return the applied processing steps (incl. scores) as a set ordered by processing step reference (option) - const variant. More...
void | addProcessingStep (const AppliedProcessingStep &step)
void | addProcessingStep (ProcessingStepRef step_ref, const std::map< ScoreTypeRef, double > &scores=std::map< ScoreTypeRef, double >())
| Add a processing step (and associated scores, if any) More...
void | addScore (ScoreTypeRef score_type, double score, const boost::optional< ProcessingStepRef > &processing_step_opt=boost::none)
| Add a score (possibly connected to a processing step) More...
ScoredProcessingResult & | operator+= (const ScoredProcessingResult &other)
| Merge in data from another object. More...
std::pair< double, bool > | getScore (ScoreTypeRef score_ref) const
std::pair< double, bool > | getScore (ScoreTypeRef score_ref, boost::optional< ProcessingStepRef > processing_step_opt) const
std::tuple< double, boost::optional< ProcessingStepRef >, bool > | getScoreAndStep (ScoreTypeRef score_ref) const
Public Member Functions inherited from MetaInfoInterface
| MetaInfoInterface ()
| Constructor. More...
| MetaInfoInterface (const MetaInfoInterface &rhs)
| Copy constructor. More...
| MetaInfoInterface (MetaInfoInterface &&) noexcept
| Move constructor. More...
| ~MetaInfoInterface ()
| Destructor. More...
MetaInfoInterface & | operator= (const MetaInfoInterface &rhs)
| Assignment operator. More...
MetaInfoInterface & | operator= (MetaInfoInterface &&) noexcept
| Move assignment operator. More...
bool | operator== (const MetaInfoInterface &rhs) const
| Equality operator. More...
bool | operator!= (const MetaInfoInterface &rhs) const
| Equality operator. More...
const DataValue & | getMetaValue (const String &name, const DataValue &default_value=DataValue::EMPTY) const
| Returns the value corresponding to a string, or a default value (default: DataValue::EMPTY) if not found. More...
const DataValue & | getMetaValue (UInt index, const DataValue &default_value=DataValue::EMPTY) const
| Returns the value corresponding to an index, or a default value (default: DataValue::EMPTY) if not found. More...
bool | metaValueExists (const String &name) const
| Returns whether an entry with the given name exists. More...
bool | metaValueExists (UInt index) const
| Returns whether an entry with the given index exists. More...
void | setMetaValue (const String &name, const DataValue &value)
| Sets the DataValue corresponding to a name. More...
void | setMetaValue (UInt index, const DataValue &value)
| Sets the DataValue corresponding to an index. More...
void | removeMetaValue (const String &name)
| Removes the DataValue corresponding to `name` if it exists. More...
void | removeMetaValue (UInt index)
| Removes the DataValue corresponding to `index` if it exists. More...
void | getKeys (std::vector< String > &keys) const
| Fills the given vector with a list of all keys for which a value is set. More...
void | getKeys (std::vector< UInt > &keys) const
| Fills the given vector with a list of all keys for which a value is set. More...
bool | isMetaEmpty () const
| Returns if the MetaInfo is empty. More...
void | clearMetaInfo ()
| Removes all meta values. More...

## Public Attributes

SeqType | sequence
ParentMatches | parent_matches
Public Attributes inherited from ScoredProcessingResult
AppliedProcessingSteps | steps_and_scores

## Additional Inherited Members

Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistry & | metaRegistry ()
| Returns a reference to the MetaInfoRegistry. More...
Protected Member Functions inherited from ScoredProcessingResult
| ScoredProcessingResult (const AppliedProcessingSteps &steps_and_scores=AppliedProcessingSteps())
| ScoredProcessingResult (const ScoredProcessingResult &)=default
Protected Member Functions inherited from MetaInfoInterface
void | createIfNotExists_ ()
| Creates the MetaInfo object if it does not exist. More...
Protected Attributes inherited from MetaInfoInterface
MetaInfo * | meta_
| Pointer to the MetaInfo object (0 by default) More...

## Detailed Description

### template<typename SeqType>
struct OpenMS::IdentificationDataInternal::IdentifiedSequence< SeqType >

Identified sequence (peptide or oligonucleotide)

## Constructor & Destructor Documentation

## ◆ IdentifiedSequence() [1/2]

IdentifiedSequence | ( | const SeqType & | sequence,
|  | const ParentMatches & | parent_matches = `ParentMatches()`,
|  | const AppliedProcessingSteps & | steps_and_scores = `AppliedProcessingSteps()`
| ) |  |

inline explicit

## ◆ IdentifiedSequence() [2/2]

IdentifiedSequence | ( | const IdentifiedSequence< SeqType > & | other | ) |

default

## Member Function Documentation

## ◆ allParentsAreDecoys()

bool allParentsAreDecoys | ( |  | ) | const

inline

References IdentifiedSequence< SeqType >::parent_matches.

## ◆ operator+=()

IdentifiedSequence& operator+= | ( | const IdentifiedSequence< SeqType > & | other | ) |

inline

References ScoredProcessingResult::operator+=(), and IdentifiedSequence< SeqType >::parent_matches.

## Member Data Documentation

## ◆ parent_matches

ParentMatches parent_matches

Referenced by IdentifiedSequence< SeqType >::allParentsAreDecoys(), and IdentifiedSequence< SeqType >::operator+=().

## ◆ sequence

SeqType sequence

Referenced by NucleicAcidSearchEngine::postProcessHits_().