Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages
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>

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...
 
DoubleReal 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 ( )
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::InvalidValueis thrown when the filter is not formatted properly
bool operator!= ( const DataFilter rhs) const
inline

Inequality operator.

bool operator== ( const DataFilter rhs) const
inline
String toString ( ) const

Returns a string representation of the filter.

Member Data Documentation

FilterType field
String meta_name

Name of the considered meta information.

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

DoubleReal value
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==().


OpenMS / TOPP release 1.11.1 Documentation generated on Thu Nov 14 2013 11:19:29 using doxygen 1.8.5