RangeRT Struct Reference

#include <OpenMS/KERNEL/RangeManager.h>

Inheritance diagram for RangeRT:

Collaboration diagram for RangeRT:

Public Member Functions
	RangeRT ()=default
	RangeRT (const double min, const double max)
void	extendRT (const double value)
	extend the range such that it includes the given value More...
bool	containsRT (const double value) const
	is value within [min, max]? More...
bool	containsRT (const RangeBase &inner_range) const
	is the range inner_range within [min, max] of this range? More...
Accessors for min and max
We use accessors, to keep range consistent (i.e. ensure that min <= max)
void	setMinRT (const double min)
	sets the minimum (and the maximum, if uninitialized) More...
void	setMaxRT (const double max)
	sets the maximum (and the minimum, if uninitialized) More...
double	getMinRT () const
	only useful if isEmpty() returns false More...
double	getMaxRT () const
	only useful if isEmpty() returns false More...
Public Member Functions inherited from RangeBase
	RangeBase ()=default
	Ctor: initialize with empty range. More...
	RangeBase (const double min, const double max)
void	clear ()
	make the range empty, i.e. isEmpty() will be true More...
bool	isEmpty () const
	is the range empty (i.e. default constructed or cleared using clear())? More...
bool	contains (const double value) const
	is value within [min, max]? More...
bool	contains (const RangeBase &inner_range) const
	is the range inner_range within [min, max]? More...
void	extend (const RangeBase &other)
	ensure the range includes the range of other More...
void	extend (const double value)
	extend the range such that it includes the given value More...
void	scaleBy (const double factor)
	Scale the range of the dimension by a factor. A factor > 1 increases the range; factor < 1 decreases it. More...
void	assign (const RangeBase &rhs)
bool	operator== (const RangeBase &rhs) const
void	setMin (const double min)
	sets the minimum (and the maximum, if uninitialized) More...
void	setMax (const double max)
	sets the maximum (and the minimum, if uninitialized) More...
double	getMin () const
	only useful if isEmpty() returns false More...
double	getMax () const
	only useful if isEmpty() returns false More...

Static Public Attributes
static const MSDim	DIM = MSDim::RT

Additional Inherited Members
Protected Attributes inherited from RangeBase
double	min_ = std::numeric_limits<double>::max()
double	max_ = -std::numeric_limits<double>::max()

Constructor & Destructor Documentation

RangeRT() [1/2]

RangeRT ( )

default

RangeRT() [2/2]

RangeRT ( const double  min, const double  max  )

inline

Member Function Documentation

containsRT() [1/2]

bool containsRT ( const double  value ) const

inline

is value within [min, max]?

References RangeBase::contains().

containsRT() [2/2]

bool containsRT ( const RangeBase &  inner_range ) const

inline

is the range inner_range within [min, max] of this range?

References RangeBase::contains().

extendRT()

void extendRT ( const double  value )

inline

extend the range such that it includes the given value

getMaxRT()

double getMaxRT ( ) const

inline

only useful if isEmpty() returns false

getMinRT()

double getMinRT ( ) const

inline

only useful if isEmpty() returns false

setMaxRT()

void setMaxRT ( const double  max )

inline

sets the maximum (and the minimum, if uninitialized)

setMinRT()

void setMinRT ( const double  min )

inline

sets the minimum (and the maximum, if uninitialized)

Member Data Documentation

DIM

const MSDim DIM = MSDim::RT

static