ProteinIdentification::ProteinGroup Class Reference

Bundles multiple (e.g. indistinguishable) proteins in a group. More...

#include <OpenMS/METADATA/ProteinIdentification.h>

Public Types
typedef OpenMS::DataArrays::FloatDataArray	FloatDataArray
	Float data array vector type. More...
typedef std::vector< FloatDataArray >	FloatDataArrays
typedef OpenMS::DataArrays::StringDataArray	StringDataArray
	String data array vector type. More...
typedef std::vector< StringDataArray >	StringDataArrays
typedef OpenMS::DataArrays::IntegerDataArray	IntegerDataArray
	Integer data array vector type. More...
typedef std::vector< IntegerDataArray >	IntegerDataArrays

Public Member Functions
	ProteinGroup ()
bool	operator== (const ProteinGroup &rhs) const
	Equality operator. More...
bool	operator< (const ProteinGroup &rhs) const

Public Attributes
double	probability
	Probability of this group. More...
std::vector< String >	accessions
	Accessions of (indistinguishable) proteins that belong to the same group. More...

data array methods
Float data arrays These methods are used to annotate protein group meta information. These statements should help you chose which approach to use Access to meta info arrays is slower than to a member variable Access to meta info arrays is faster than to a MetaInfoInterface Meta info arrays are stored when using mzML format for storing
FloatDataArrays	float_data_arrays_
	Float data arrays. More...
StringDataArrays	string_data_arrays_
	String data arrays. More...
IntegerDataArrays	integer_data_arrays_
	Integer data arrays. More...
const FloatDataArrays &	getFloatDataArrays () const
	Returns a const reference to the float meta data arrays. More...
FloatDataArrays &	getFloatDataArrays ()
	Returns a mutable reference to the float meta data arrays. More...
void	setFloatDataArrays (const FloatDataArrays &fda)
	Sets the float meta data arrays. More...
const StringDataArrays &	getStringDataArrays () const
	Returns a const reference to the string meta data arrays. More...
StringDataArrays &	getStringDataArrays ()
	Returns a mutable reference to the string meta data arrays. More...
void	setStringDataArrays (const StringDataArrays &sda)
	Sets the string meta data arrays. More...
const IntegerDataArrays &	getIntegerDataArrays () const
	Returns a const reference to the integer meta data arrays. More...
IntegerDataArrays &	getIntegerDataArrays ()
	Returns a mutable reference to the integer meta data arrays. More...
void	setIntegerDataArrays (const IntegerDataArrays &ida)
	Sets the integer meta data arrays. More...
IntegerDataArray &	getIntegerDataArrayByName (String name)
	Returns a mutable reference to the first integer meta data array with the given name. More...
StringDataArray &	getStringDataArrayByName (String name)
	Returns a mutable reference to the first string meta data array with the given name. More...
FloatDataArray &	getFloatDataArrayByName (String name)
	Returns a mutable reference to the first float meta data array with the given name. More...
const IntegerDataArray &	getIntegerDataArrayByName (String name) const
	Returns a const reference to the first integer meta data array with the given name. More...
const StringDataArray &	getStringDataArrayByName (String name) const
	Returns a const reference to the first string meta data array with the given name. More...
const FloatDataArray &	getFloatDataArrayByName (String name) const
	Returns a const reference to the first float meta data array with the given name. More...

Detailed Description

Bundles multiple (e.g. indistinguishable) proteins in a group.

Member Typedef Documentation

FloatDataArray

typedef OpenMS::DataArrays::FloatDataArray FloatDataArray

Float data array vector type.

FloatDataArrays

typedef std::vector<FloatDataArray> FloatDataArrays

IntegerDataArray

typedef OpenMS::DataArrays::IntegerDataArray IntegerDataArray

Integer data array vector type.

IntegerDataArrays

typedef std::vector<IntegerDataArray> IntegerDataArrays

StringDataArray

typedef OpenMS::DataArrays::StringDataArray StringDataArray

String data array vector type.

StringDataArrays

typedef std::vector<StringDataArray> StringDataArrays

Constructor & Destructor Documentation

ProteinGroup()

ProteinGroup

(

)

Member Function Documentation

getFloatDataArrayByName() [1/2]

FloatDataArray& getFloatDataArrayByName ( String  name )

inline

Returns a mutable reference to the first float meta data array with the given name.

getFloatDataArrayByName() [2/2]

const FloatDataArray& getFloatDataArrayByName ( String  name ) const

inline

Returns a const reference to the first float meta data array with the given name.

getFloatDataArrays() [1/2]

FloatDataArrays& getFloatDataArrays ( )

inline

Returns a mutable reference to the float meta data arrays.

getFloatDataArrays() [2/2]

const FloatDataArrays& getFloatDataArrays

(

)

const

Returns a const reference to the float meta data arrays.

getIntegerDataArrayByName() [1/2]

IntegerDataArray& getIntegerDataArrayByName ( String  name )

inline

Returns a mutable reference to the first integer meta data array with the given name.

getIntegerDataArrayByName() [2/2]

const IntegerDataArray& getIntegerDataArrayByName ( String  name ) const

inline

Returns a const reference to the first integer meta data array with the given name.

getIntegerDataArrays() [1/2]

IntegerDataArrays& getIntegerDataArrays

(

)

Returns a mutable reference to the integer meta data arrays.

getIntegerDataArrays() [2/2]

const IntegerDataArrays& getIntegerDataArrays

(

)

const

Returns a const reference to the integer meta data arrays.

getStringDataArrayByName() [1/2]

StringDataArray& getStringDataArrayByName ( String  name )

inline

Returns a mutable reference to the first string meta data array with the given name.

getStringDataArrayByName() [2/2]

const StringDataArray& getStringDataArrayByName ( String  name ) const

inline

Returns a const reference to the first string meta data array with the given name.

getStringDataArrays() [1/2]

StringDataArrays& getStringDataArrays

(

)

Returns a mutable reference to the string meta data arrays.

getStringDataArrays() [2/2]

const StringDataArrays& getStringDataArrays

(

)

const

Returns a const reference to the string meta data arrays.

operator<()

bool operator<

(

const ProteinGroup &

rhs

)

const

operator==()

bool operator==

(

const ProteinGroup &

rhs

)

const

Equality operator.

setFloatDataArrays()

void setFloatDataArrays

(

const FloatDataArrays &

fda

)

Sets the float meta data arrays.

setIntegerDataArrays()

void setIntegerDataArrays

(

const IntegerDataArrays &

ida

)

Sets the integer meta data arrays.

setStringDataArrays()

void setStringDataArrays

(

const StringDataArrays &

sda

)

Sets the string meta data arrays.

Member Data Documentation

accessions

std::vector<String> accessions

Accessions of (indistinguishable) proteins that belong to the same group.

float_data_arrays_

FloatDataArrays float_data_arrays_

private

Float data arrays.

integer_data_arrays_

IntegerDataArrays integer_data_arrays_

private

Integer data arrays.

probability

double probability

Probability of this group.

string_data_arrays_

StringDataArrays string_data_arrays_

private

String data arrays.