IdentificationHit Class Reference

Represents a object which can store the information of an analysisXML instance. More...

#include <OpenMS/METADATA/IdentificationHit.h>

Inheritance diagram for IdentificationHit:

Collaboration diagram for IdentificationHit:

Public Member Functions
constructors,destructors,assignment operator
	IdentificationHit ()
	Default constructor. More...
	IdentificationHit (const IdentificationHit &)=default
	Copy constructor. More...
virtual	~IdentificationHit ()
	Destructor. More...
	IdentificationHit (IdentificationHit &&)=default
	Move constructor. More...
IdentificationHit &	operator= (const IdentificationHit &)=default
	Assignment operator. More...
IdentificationHit &	operator= (IdentificationHit &&) &=default
	Move assignment operator. More...
bool	operator== (const IdentificationHit &rhs) const
	Equality operator. More...
bool	operator!= (const IdentificationHit &rhs) const
	Inequality operator. More...
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...
void	swap (MetaInfoInterface &rhs)
	Swap contents. 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
	Returns the value corresponding to a string, or DataValue::EMPTY if not found. More...
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. More...
const DataValue &	getMetaValue (UInt index) const
	Returns the value corresponding to the index, or DataValue::EMPTY if not found. More...
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. 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	addMetaValues (const MetaInfoInterface &from)
	function to copy all meta values from one object to this one 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...

Accessors
String	id_
	identifier More...
Int	charge_
	peptide charge More...
double	calculated_mass_to_charge_
	calculated mass to charge ratio More...
double	experimental_mass_to_charge_
	experimental mass to charge ratio More...
String	name_
	name More...
bool	pass_threshold_
	pass threshold More...
Int	rank_
	rank of the peptide More...
void	setId (const String &id)
	sets the identifier More...
const String &	getId () const
	returns the id More...
void	setCharge (Int charge)
	sets the charge state of the peptide More...
Int	getCharge () const
	returns the charge state More...
void	setCalculatedMassToCharge (double mz)
	sets the calculated mass to charge ratio More...
double	getCalculatedMassToCharge () const
	returns the calculated mass to charge ratio More...
void	setExperimentalMassToCharge (double mz)
	sets the experimental mass to charge ratio More...
double	getExperimentalMassToCharge () const
	returns the experimental mass to charge More...
void	setName (const String &name)
	sets the name More...
const String &	getName () const
	returns the name More...
void	setPassThreshold (bool pass)
	sets whether the peptide passed the threshold More...
bool	getPassThreshold () const
	returns whether the peptide passed the threshold More...
void	setRank (Int rank)
	set the rank of the peptide More...
Int	getRank () const
	returns the rank of the peptide More...

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

Represents a object which can store the information of an analysisXML instance.

Todo:

docu (Andreas)

Constructor & Destructor Documentation

IdentificationHit() [1/3]

IdentificationHit

(

)

Default constructor.

IdentificationHit() [2/3]

IdentificationHit ( const IdentificationHit &  )

default

Copy constructor.

~IdentificationHit()

virtual ~IdentificationHit ( )

virtual

Destructor.

IdentificationHit() [3/3]

IdentificationHit ( IdentificationHit &&  )

default

Move constructor.

Member Function Documentation

getCalculatedMassToCharge()

double getCalculatedMassToCharge

(

)

const

returns the calculated mass to charge ratio

getCharge()

Int getCharge

(

)

const

returns the charge state

getExperimentalMassToCharge()

double getExperimentalMassToCharge

(

)

const

returns the experimental mass to charge

getId()

const String& getId

(

)

const

returns the id

getName()

const String& getName

(

)

const

returns the name

getPassThreshold()

bool getPassThreshold

(

)

const

returns whether the peptide passed the threshold

getRank()

Int getRank

(

)

const

returns the rank of the peptide

operator!=()

bool operator!=

(

const IdentificationHit &

rhs

)

const

Inequality operator.

operator=() [1/2]

IdentificationHit& operator= ( const IdentificationHit &  )

default

Assignment operator.

operator=() [2/2]

IdentificationHit& operator= ( IdentificationHit &&  ) &

default

Move assignment operator.

operator==()

bool operator==

(

const IdentificationHit &

rhs

)

const

Equality operator.

setCalculatedMassToCharge()

void setCalculatedMassToCharge

(

double

mz

)

sets the calculated mass to charge ratio

setCharge()

void setCharge

(

Int

charge

)

sets the charge state of the peptide

setExperimentalMassToCharge()

void setExperimentalMassToCharge

(

double

mz

)

sets the experimental mass to charge ratio

setId()

void setId

(

const String &

id

)

sets the identifier

setName()

void setName

(

const String &

name

)

sets the name

setPassThreshold()

void setPassThreshold

(

bool

pass

)

sets whether the peptide passed the threshold

setRank()

void setRank

(

Int

rank

)

set the rank of the peptide

Member Data Documentation

calculated_mass_to_charge_

double calculated_mass_to_charge_

protected

calculated mass to charge ratio

charge_

Int charge_

protected

peptide charge

experimental_mass_to_charge_

double experimental_mass_to_charge_

protected

experimental mass to charge ratio

id_

String id_

protected

identifier

name_

String name_

protected

name

pass_threshold_

bool pass_threshold_

protected

pass threshold

rank_

Int rank_

protected

rank of the peptide