ParentMatch Struct Reference

Meta data for the association between an identified molecule (e.g. peptide) and a parent sequence (e.g. protein). More...

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

Inheritance diagram for ParentMatch:

Collaboration diagram for ParentMatch:

Public Member Functions
	ParentMatch (Size start_pos=UNKNOWN_POSITION, Size end_pos=UNKNOWN_POSITION, String left_neighbor=UNKNOWN_NEIGHBOR, String right_neighbor=UNKNOWN_NEIGHBOR)
bool	operator< (const ParentMatch &other) const
bool	operator== (const ParentMatch &other) const
bool	hasValidPositions (Size molecule_length=0, Size parent_length=0) const
Public Member Functions inherited from MetaInfoInterface
	MetaInfoInterface ()=default
	Constructor.
	MetaInfoInterface (const MetaInfoInterface &rhs)
	Copy constructor.
	MetaInfoInterface (MetaInfoInterface &&) noexcept
	Move constructor.
	~MetaInfoInterface ()
	Destructor.
MetaInfoInterface &	operator= (const MetaInfoInterface &rhs)
	Assignment operator.
MetaInfoInterface &	operator= (MetaInfoInterface &&) noexcept
	Move assignment operator.
void	swap (MetaInfoInterface &rhs)
	Swap contents.
bool	operator== (const MetaInfoInterface &rhs) const
	Equality operator.
bool	operator!= (const MetaInfoInterface &rhs) const
	Equality operator.
const DataValue &	getMetaValue (const String &name) const
	Returns the value corresponding to a string, or DataValue::EMPTY if not found.
DataValue	getMetaValue (const String &name, const DataValue &default_value) const
	Returns the value corresponding to a string, or a default value (e.g.: DataValue::EMPTY) if not found
const DataValue &	getMetaValue (UInt index) const
	Returns the value corresponding to the index, or DataValue::EMPTY if not found.
DataValue	getMetaValue (UInt index, const DataValue &default_value) const
	Returns the value corresponding to the index, or a default value (e.g.: DataValue::EMPTY) if not found
bool	metaValueExists (const String &name) const
	Returns whether an entry with the given name exists.
bool	metaValueExists (UInt index) const
	Returns whether an entry with the given index exists.
void	setMetaValue (const String &name, const DataValue &value)
	Sets the DataValue corresponding to a name.
void	setMetaValue (UInt index, const DataValue &value)
	Sets the DataValue corresponding to an index.
void	removeMetaValue (const String &name)
	Removes the DataValue corresponding to name if it exists.
void	removeMetaValue (UInt index)
	Removes the DataValue corresponding to index if it exists.
void	addMetaValues (const MetaInfoInterface &from)
void	getKeys (std::vector< String > &keys) const
	Fills the given vector with a list of all keys for which a value is set.
void	getKeys (std::vector< UInt > &keys) const
	Fills the given vector with a list of all keys for which a value is set.
bool	isMetaEmpty () const
	Returns if the MetaInfo is empty.
void	clearMetaInfo ()
	Removes all meta values.

Public Attributes
Size	start_pos
Size	end_pos
String	left_neighbor
String	right_neighbor

Static Public Attributes
static constexpr Size	UNKNOWN_POSITION = Size(-1)
static constexpr char	UNKNOWN_NEIGHBOR = 'X'
static constexpr char	LEFT_TERMINUS = '['
static constexpr char	RIGHT_TERMINUS = ']'

Additional Inherited Members
Static Public Member Functions inherited from MetaInfoInterface
static MetaInfoRegistry &	metaRegistry ()
	Returns a reference to the MetaInfoRegistry.
Protected Member Functions inherited from MetaInfoInterface
void	createIfNotExists_ ()
	Creates the MetaInfo object if it does not exist.
Protected Attributes inherited from MetaInfoInterface
MetaInfo *	meta_ = nullptr
	Pointer to the MetaInfo object.

Detailed Description

Meta data for the association between an identified molecule (e.g. peptide) and a parent sequence (e.g. protein).

Constructor & Destructor Documentation

ParentMatch()

ParentMatch ( Size  start_pos = UNKNOWN_POSITION, Size  end_pos = UNKNOWN_POSITION, String  left_neighbor = UNKNOWN_NEIGHBOR, String  right_neighbor = UNKNOWN_NEIGHBOR  )

inlineexplicit

Member Function Documentation

hasValidPositions()

bool hasValidPositions ( Size  molecule_length = 0, Size  parent_length = 0  ) const

inline

References ParentMatch::end_pos, ParentMatch::start_pos, and ParentMatch::UNKNOWN_POSITION.

operator<()

bool operator< ( const ParentMatch &  other ) const

inline

References ParentMatch::end_pos, and ParentMatch::start_pos.

operator==()

bool operator== ( const ParentMatch &  other ) const

inline

References ParentMatch::end_pos, and ParentMatch::start_pos.

Member Data Documentation

end_pos

Size end_pos

Referenced by ParentMatch::hasValidPositions(), ParentMatch::operator<(), and ParentMatch::operator==().

left_neighbor

String left_neighbor

LEFT_TERMINUS

constexpr char LEFT_TERMINUS = '['

staticconstexpr

right_neighbor

String right_neighbor

RIGHT_TERMINUS

constexpr char RIGHT_TERMINUS = ']'

staticconstexpr

start_pos

Size start_pos

Referenced by ParentMatch::hasValidPositions(), ParentMatch::operator<(), and ParentMatch::operator==().

UNKNOWN_NEIGHBOR

constexpr char UNKNOWN_NEIGHBOR = 'X'

staticconstexpr

UNKNOWN_POSITION

constexpr Size UNKNOWN_POSITION = Size(-1)

staticconstexpr

Referenced by ParentMatch::hasValidPositions().