| OpenMS 2.5.0

Private Member Functions | List of all members
FeatureHandle::FeatureHandleMutable_ Class Reference

Helper class returned by FeatureHandle::asMutable(), which see. More...

`#include <OpenMS/KERNEL/FeatureHandle.h>`

Inheritance diagram for FeatureHandle::FeatureHandleMutable_:

## Private Member Functions

| FeatureHandleMutable_ ()
| FeatureHandleMutable_ (const FeatureHandleMutable_ &)
void | setMapIndex (UInt64 i)
| Set the map index. More...

## Additional Inherited Members

Public Types inherited from FeatureHandle
typedef Int | ChargeType
| Charge type. More...
typedef float | WidthType
| Feature width type. More...
Public Types inherited from Peak2D
typedef float | IntensityType
| Intensity type. More...
typedef double | CoordinateType
| Coordinate type (of the position) More...
typedef DPosition< 2 > | PositionType
| Position type. More...
enum | DimensionDescription { RT = 0, MZ = 1, DIMENSION = 2 }
| This enum maps the symbolic names of the dimensions to numbers. More...
Public Types inherited from UniqueIdInterface
enum | { INVALID = 0 }
| This is the invalid unique id (cast it to a UInt64 if you like) More...
Public Member Functions inherited from FeatureHandle
bool | operator== (const FeatureHandle &i) const
| Equality operator. More...
bool | operator!= (const FeatureHandle &i) const
| Equality operator. More...
| FeatureHandle ()
| Default constructor. More...
| FeatureHandle (UInt64 map_index, const Peak2D &point, UInt64 element_index)
| Constructor with map index, element index and position. More...
| FeatureHandle (UInt64 map_index, const BaseFeature &feature)
| Constructor from map index and basic feature. More...
| FeatureHandle (const FeatureHandle &rhs)
| Copy constructor. More...
FeatureHandle & | operator= (const FeatureHandle &rhs)
| Assignment operator. More...
| ~FeatureHandle () override
| Destructor. More...
FeatureHandleMutable_ & | asMutable () const
| Override (most of all) constness. More...
UInt64 | getMapIndex () const
| Returns the map index. More...
void | setMapIndex (UInt64 i)
| Set the map index. More...
void | setCharge (ChargeType charge)
| Sets the charge. More...
ChargeType | getCharge () const
| Returns the charge. More...
void | setWidth (WidthType width)
| Sets the width (FWHM) More...
WidthType | getWidth () const
| Returns the width (FWHM) More...
Public Member Functions inherited from Peak2D
Peak2D & | operator= (const Peak2D &rhs)=default
| Assignment operator. More...
Peak2D & | operator= (Peak2D &&) &=default
| Move assignment operator. More...
bool | operator== (const Peak2D &rhs) const
| Equality operator. More...
bool | operator!= (const Peak2D &rhs) const
| Equality operator. More...
| Peak2D ()
| Peak2D (const PositionType &pos, const IntensityType in)
| Member constructor. More...
| Peak2D (const Peak2D &p)=default
| Copy constructor. More...
| Peak2D (Peak2D &&)=default
| Move constructor. More...
| ~Peak2D ()
| Destructor. More...
IntensityType | getIntensity () const
void | setIntensity (IntensityType intensity)
| Non-mutable access to the data point intensity (height) More...
PositionType const & | getPosition () const
| Non-mutable access to the position. More...
PositionType & | getPosition ()
| Mutable access to the position. More...
void | setPosition (const PositionType &position)
| Mutable access to the position. More...
CoordinateType | getMZ () const
| Returns the m/z coordinate (index 1) More...
void | setMZ (CoordinateType coordinate)
| Mutable access to the m/z coordinate (index 1) More...
CoordinateType | getRT () const
| Returns the RT coordinate (index 0) More...
void | setRT (CoordinateType coordinate)
| Mutable access to the RT coordinate (index 0) More...
Public Member Functions inherited from UniqueIdInterface
| UniqueIdInterface ()
| Default constructor - the unique id will be invalid More...
| UniqueIdInterface (const UniqueIdInterface &rhs)=default
| Copy constructor - copies the unique id. More...
| UniqueIdInterface (UniqueIdInterface &&rhs)=default
| Move constructor. More...
UniqueIdInterface & | operator= (UniqueIdInterface const &rhs)=default
| Assignment operator - copies the unique id. More...
UniqueIdInterface & | operator= (UniqueIdInterface &&) &=default
| Move Assignment operator - copies the unique id. More...
virtual | ~UniqueIdInterface ()=default
| Destructor. More...
bool | operator== (UniqueIdInterface const &rhs) const
| Equality comparison operator - the unique ids must be equal (!) More...
UInt64 | getUniqueId () const
| Non-mutable access to unique id - returns the unique id. More...
Size | clearUniqueId ()
| Clear the unique id. The new unique id will be invalid. Returns 1 if the unique id was changed, 0 otherwise. More...
void | swap (UniqueIdInterface &from)
Size | hasValidUniqueId () const
| Returns whether the unique id is valid. Returns 1 if the unique id is valid, 0 otherwise. More...
Size | hasInvalidUniqueId () const
| Returns whether the unique id is invalid. Returns 1 if the unique id is invalid, 0 otherwise. More...
Size | setUniqueId ()
| Assigns a new, valid unique id. Always returns 1. More...
Size | ensureUniqueId ()
| Assigns a valid unique id, but only if the present one is invalid. Returns 1 if the unique id was changed, 0 otherwise. More...
void | setUniqueId (UInt64 rhs)
| Assigns the given unique id. More...
void | setUniqueId (const String &rhs)
| Mutable access to unique id. More...
Static Public Member Functions inherited from Peak2D
static char const * | shortDimensionName (UInt const dim)
| Short name of the dimension (abbreviated form) More...
static char const * | shortDimensionNameRT ()
| Short name of the dimension (abbreviated form) More...
static char const * | shortDimensionNameMZ ()
| Short name of the dimension (abbreviated form) More...
static char const * | fullDimensionName (UInt const dim)
| Full name of the dimension (self-explanatory form) More...
static char const * | fullDimensionNameRT ()
| Full name of the dimension (self-explanatory form) More...
static char const * | fullDimensionNameMZ ()
| Full name of the dimension (self-explanatory form) More...
static char const * | shortDimensionUnit (UInt const dim)
| Unit of measurement (abbreviated form) More...
static char const * | shortDimensionUnitRT ()
| Unit of measurement (abbreviated form) More...
static char const * | shortDimensionUnitMZ ()
| Unit of measurement (abbreviated form) More...
static char const * | fullDimensionUnit (UInt const dim)
| Unit of measurement (self-explanatory form) More...
static char const * | fullDimensionUnitRT ()
| Unit of measurement (self-explanatory form) More...
static char const * | fullDimensionUnitMZ ()
| Unit of measurement (self-explanatory form) More...
Static Public Member Functions inherited from UniqueIdInterface
static bool | isValid (UInt64 unique_id)
| Returns true if the unique_id is valid, false otherwise. More...
Protected Attributes inherited from FeatureHandle
UInt64 | map_index_
| Index of the element's container. More...
Int | charge_
| Charge of the feature. More...
float | width_
| Width of the feature (FWHM) More...
Protected Attributes inherited from Peak2D
PositionType | position_
| The data point position. More...
IntensityType | intensity_
| The data point intensity. More...
Protected Attributes inherited from UniqueIdInterface
UInt64 | unique_id_
| the unique id More...
Static Protected Attributes inherited from Peak2D
static char const *const | dimension_name_short_ [DIMENSION]
| Short name of the dimension (abbreviated form) More...
static char const *const | dimension_name_full_ [DIMENSION]
| Full name of the dimension (self-explanatory form) More...
static char const *const | dimension_unit_short_ [DIMENSION]
| Unit of measurement (abbreviated form) More...
static char const *const | dimension_unit_full_ [DIMENSION]
| Unit of measurement (self-explanatory form) More...

## Detailed Description

Helper class returned by FeatureHandle::asMutable(), which see.

Note that the mutators for unique id and map index are declared private. This is done because these are used by IndexLess comparator. This way it is a bit harder to use FeatureHandle::asMutable() for illegal purposes ;-)

## Constructor & Destructor Documentation

## ◆ FeatureHandleMutable_() [1/2]

FeatureHandleMutable_ | ( |  | ) |

private

## ◆ FeatureHandleMutable_() [2/2]

FeatureHandleMutable_ | ( | const FeatureHandleMutable_ & |  | ) |

private

## Member Function Documentation

## ◆ setMapIndex()

void setMapIndex

private

Set the map index.