Representation of a parent molecule that is identified only indirectly (e.g. a protein). More...

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

Inheritance diagram for ParentMolecule:

Public Member Functions
	ParentMolecule (const String &accession, MoleculeType molecule_type=MoleculeType::PROTEIN, const String &sequence="", const String &description="", double coverage=0.0, bool is_decoy=false, const AppliedProcessingSteps &steps_and_scores=AppliedProcessingSteps())

	ParentMolecule (const ParentMolecule &)=default

ParentMolecule &	operator+= (const ParentMolecule &other)

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
String	accession

enum MoleculeType	molecule_type

String	sequence

String	description

double	coverage
	sequence coverage as a fraction between 0 and 1 More...

bool	is_decoy

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

Representation of a parent molecule that is identified only indirectly (e.g. a protein).

Constructor & Destructor Documentation

◆ ParentMolecule() [1/2]

ParentMolecule	(	const String &	accession,
		MoleculeType	molecule_type = `MoleculeType::PROTEIN`,
		const String &	sequence = `""`,
		const String &	description = `""`,
		double	coverage = `0.0`,
		bool	is_decoy = `false`,
		const AppliedProcessingSteps &	steps_and_scores = `AppliedProcessingSteps()`
	)