OpenMS  2.6.0
Public Member Functions | Public Attributes | List of all members
DataFilters::DataFilter Struct Reference

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

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

Collaboration diagram for DataFilters::DataFilter:
[legend]

Public Member Functions

 DataFilter ()
 Default constructor. More...
 
String toString () const
 Returns a string representation of the filter. More...
 
void fromString (const String &filter)
 Parses filter and sets the filter properties accordingly. More...
 
bool operator== (const DataFilter &rhs) const
 Equality operator. More...
 
bool operator!= (const DataFilter &rhs) const
 Inequality operator. More...
 

Public Attributes

FilterType field
 Field to filter. More...
 
FilterOperation op
 Filter operation. More...
 
double value
 Value for comparison. More...
 
String value_string
 String value for comparison (for meta data) More...
 
String meta_name
 Name of the considered meta information. More...
 
bool value_is_numerical
 Bool value that indicates if the specified value is numerical. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ DataFilter()

Default constructor.

Member Function Documentation

◆ fromString()

void fromString ( const String filter)

Parses filter and sets the filter properties accordingly.

This method accepts the format provided by toString().

Exceptions
Exception::InvalidValueis thrown when the filter is not formatted properly

◆ operator!=()

bool operator!= ( const DataFilter rhs) const

Inequality operator.

◆ operator==()

bool operator== ( const DataFilter rhs) const

Equality operator.

◆ toString()

String toString ( ) const

Returns a string representation of the filter.

Member Data Documentation

◆ field

FilterType field

Field to filter.

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

◆ meta_name

String meta_name

Name of the considered meta information.

Referenced by DataFilters::passes().

◆ op

Filter operation.

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

◆ value

double value

Value for comparison.

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

◆ value_is_numerical

bool value_is_numerical

Bool value that indicates if the specified value is numerical.

◆ value_string

String value_string

String value for comparison (for meta data)