OSWTransition Struct Reference

High-level meta-data of one fragment-ion transition referenced by an OSWPeakGroup. More...

#include <OpenMS/DATASTRUCTURES/OSWData.h>

Collaboration diagram for OSWTransition:

Public Member Functions
	OSWTransition ()=default
	default c'tor
	OSWTransition (const std::string &annotation, const UInt32 id, const float product_mz, const char type, const bool is_decoy)
	custom c'tor which fills all the members with data; all members are read-only
	OSWTransition (const OSWTransition &rhs)=default
OSWTransition &	operator= (const OSWTransition &rhs)=default
	OSWTransition (OSWTransition &&rhs)=default
OSWTransition &	operator= (OSWTransition &&rhs)=default
	~OSWTransition ()=default
const std::string &	getAnnotation () const
	e.g. y5/-0.002
UInt32	getID () const
	ID as used in OSWPeakGroup::transition_ids.
float	getProductMZ () const
	observed product m/z value
char	getType () const
	b, y
bool	isDecoy () const
	is this a decoy transition (from a decoy protein/peptide)

Private Attributes
std::string	annotation_
	e.g. y5/-0.002
UInt32	id_
	ID as used in OSWPeakGroup::transition_ids.
float	product_mz_
	observed product m/z value
char	type_
	b, y,
bool	is_decoy_
	is this a decoy transition (from a decoy protein/peptide)

Detailed Description

High-level meta-data of one fragment-ion transition referenced by an OSWPeakGroup.

Immutable after construction (the only mutating ops are the defaulted move / copy assignment overloads). The id field doubles as the chromatogram-native-id used to resolve back into an sqMass chromatogram via OSWData::fromNativeID after OSWData::buildNativeIDResolver has been called.

Constructor & Destructor Documentation

OSWTransition() [1/4]

OSWTransition ( )

default

default c'tor

OSWTransition() [2/4]

OSWTransition	(	const std::string &	annotation,
		const UInt32	id,
		const float	product_mz,
		const char	type,
		const bool	is_decoy
	)

custom c'tor which fills all the members with data; all members are read-only

OSWTransition() [3/4]

OSWTransition ( const OSWTransition &  rhs )

default

OSWTransition() [4/4]

OSWTransition ( OSWTransition &&  rhs )

default

~OSWTransition()

~OSWTransition ( )

default

Member Function Documentation

getAnnotation()

const std::string & getAnnotation ( ) const

inline

e.g. y5/-0.002

getID()

UInt32 getID ( ) const

inline

ID as used in OSWPeakGroup::transition_ids.

Referenced by OSWData::addTransition().

getProductMZ()

float getProductMZ ( ) const

inline

observed product m/z value

getType()

char getType ( ) const

inline

b, y

isDecoy()

bool isDecoy ( ) const

inline

is this a decoy transition (from a decoy protein/peptide)

operator=() [1/2]

OSWTransition & operator= ( const OSWTransition &  rhs )

default

operator=() [2/2]

OSWTransition & operator= ( OSWTransition &&  rhs )

default

Member Data Documentation

annotation_

std::string annotation_

private

e.g. y5/-0.002

id_

UInt32 id_

private

ID as used in OSWPeakGroup::transition_ids.

is_decoy_

bool is_decoy_

private

is this a decoy transition (from a decoy protein/peptide)

product_mz_

float product_mz_

private

observed product m/z value

type_

char type_

private

b, y,