Home  · Classes  · Annotated Classes  · Modules  · Members  · Namespaces  · Related Pages

IndexTuple Class Template Reference

#include <OpenMS/ANALYSIS/MAPMATCHING/IndexTuple.h>

List of all members.


Detailed Description

template<typename ContainerType = FeatureMap< Feature >>
class OpenMS::IndexTuple< ContainerType >

This class stores some needful information of an element.

The IndexTuple class is used during map matching. It stores next to an element's index (within a container), a pointer to the element itself, an index of the map it is contained as well as the transformed position of the element.

Public Types

typedef ContainerType::value_type ElementType
typedef DPosition< 2 > PositionType

Public Member Functions

 IndexTuple ()
 Default constructor.
 IndexTuple (UInt map_index, UInt element_index, const ElementType &element)
 Constructor.
 IndexTuple (const IndexTuple &source)
 Copy constructor.
IndexTupleoperator= (const IndexTuple &source)
 Assignment operator.
virtual ~IndexTuple ()
 Destructor.
UInt getMapIndex () const
 Non-mutable access to the container index.
void setMapIndex (UInt c)
 Set the container index.
UInt getElementIndex () const
 Non-mutable access to the element index.
void setElementIndex (UInt e)
 Set the element index.
const ElementTypegetElement () const
 Non-mutable access to the element.
void setElement (const ElementType &e)
 Set the element.
const PositionTypegetTransformedPosition () const
 Non-mutable access to the transformed position.
void setTransformedPosition (const PositionType &p)
 Set the transformed position.
virtual bool operator== (const IndexTuple &i) const
 Equality operator.
virtual bool operator!= (const IndexTuple &i) const
 Equality operator.

Protected Attributes

PositionType transformed_position_
 Transformed element position.
UInt map_index_
 Int of the element's container.
UInt element_index_
 Int of the element within element's container.
const ElementTypeelement_pointer_
 Pointer to the element itself.

Classes

struct  IndexLess
 Compare by getOverallQuality(). More...


Member Typedef Documentation

typedef ContainerType::value_type ElementType

typedef DPosition<2> PositionType


Constructor & Destructor Documentation

IndexTuple (  )  [inline]

Default constructor.

IndexTuple ( UInt  map_index,
UInt  element_index,
const ElementType element 
) [inline]

Constructor.

IndexTuple ( const IndexTuple< ContainerType > &  source  )  [inline]

Copy constructor.

virtual ~IndexTuple (  )  [inline, virtual]

Destructor.


Member Function Documentation

IndexTuple& operator= ( const IndexTuple< ContainerType > &  source  )  [inline]

Assignment operator.

UInt getMapIndex (  )  const [inline]

Non-mutable access to the container index.

void setMapIndex ( UInt  c  )  [inline]

Set the container index.

UInt getElementIndex (  )  const [inline]

Non-mutable access to the element index.

void setElementIndex ( UInt  e  )  [inline]

Set the element index.

const ElementType& getElement (  )  const [inline]

Non-mutable access to the element.

void setElement ( const ElementType e  )  [inline]

Set the element.

const PositionType& getTransformedPosition (  )  const [inline]

Non-mutable access to the transformed position.

void setTransformedPosition ( const PositionType p  )  [inline]

Set the transformed position.

virtual bool operator== ( const IndexTuple< ContainerType > &  i  )  const [inline, virtual]

Equality operator.

virtual bool operator!= ( const IndexTuple< ContainerType > &  i  )  const [inline, virtual]

Equality operator.


Member Data Documentation

PositionType transformed_position_ [protected]

Transformed element position.

UInt map_index_ [protected]

Int of the element's container.

UInt element_index_ [protected]

Int of the element within element's container.

const ElementType* element_pointer_ [protected]

Pointer to the element itself.


The documentation for this class was generated from the following file:
Generated Tue Apr 1 15:36:42 2008 -- using doxygen 1.5.4 OpenMS / TOPP 1.1