DataFilters::DataFilter Struct Reference

Representation of a peak/feature filter combining FilterType, FilterOperation and a value. More...

#include <OpenMS/FILTERING/DATAREDUCTION/DataFilters.h>

List of all members.

Public Member Functions
	DataFilter ()
	Default constructor.
String	toString () const
	Returns a string representation of the filter.
void	fromString (const String &filter)
	Parses filter and sets the filter properties accordingly.
bool	operator== (const DataFilter &rhs) const
	Equality operator.
bool	operator!= (const DataFilter &rhs) const
	Inequality operator.
Public Attributes
FilterType	field
	Field to filter.
FilterOperation	op
	Filter operation.
DoubleReal	value
	Value for comparison.
String	value_string
	String value for comparison (for meta data).
String	meta_name
	Name of the considered meta information.
bool	value_is_numerical
	Bool value that indicates if the specified value is numerical.

---

Detailed Description

Representation of a peak/feature filter combining FilterType, FilterOperation and a value.

---

Constructor & Destructor Documentation

DataFilter

(

)

[inline]

Default constructor.

---

Member Function Documentation

void fromString

(

const String &

filter

)

Parses filter and sets the filter properties accordingly.

This method accepts the format provided by toString().

Exceptions:

Exception::InvalidValue

is thrown when the filter is not formatted properly

bool operator!=

(

const DataFilter &

rhs

)

const [inline]

Inequality operator.

bool operator==

(

const DataFilter &

rhs

)

const [inline]

Equality operator.

References DataFilters::DataFilter::field, DataFilters::DataFilter::meta_name, DataFilters::DataFilter::op, DataFilters::DataFilter::value, DataFilters::DataFilter::value_is_numerical, and DataFilters::DataFilter::value_string.

String toString

(

)

const

Returns a string representation of the filter.

---

Member Data Documentation

FilterType field

Field to filter.

Referenced by TOPPViewBase::addData(), DataFilters::DataFilter::operator==(), and DataFilters::passes().

String meta_name

Name of the considered meta information.

Referenced by DataFilters::DataFilter::operator==(), and DataFilters::passes().

FilterOperation op

Filter operation.

Referenced by TOPPViewBase::addData(), DataFilters::metaPasses_(), DataFilters::DataFilter::operator==(), and DataFilters::passes().

DoubleReal value

Value for comparison.

Referenced by TOPPViewBase::addData(), DataFilters::metaPasses_(), DataFilters::DataFilter::operator==(), and DataFilters::passes().

bool value_is_numerical

Bool value that indicates if the specified value is numerical.

Referenced by DataFilters::metaPasses_(), and DataFilters::DataFilter::operator==().

String value_string

String value for comparison (for meta data).

Referenced by DataFilters::metaPasses_(), and DataFilters::DataFilter::operator==().