Peak< PositionType > Class Template Reference
[NMR spectra and related classes]

Generic Peak Class. More...

#include <peak.h>

Inheritance diagram for Peak< PositionType >:

List of all members.

Public Types
Typedefs
typedef PositionType	Position
Public Member Functions
Constructors and Destructors
	Peak ()
	Default Constructor.
	Peak (const Peak &peak)
	Copy Constructor.
virtual	~Peak () throw ()
	Destructor.
Accessors
const Position &	getPosition () const
	Return the peak position.
const Position &	getWidth () const
	Return the peak width.
float	getIntensity () const
	Return the peak intensity (amplitude).
void	setPosition (const Position &position)
	Set the peak position.
void	setWidth (const Position &width)
	Set the peak width.
void	setIntensity (float intensity)
	Set the peak height.
const Atom *	getAtom () const
	Return the atom pointer.
void	setAtom (const Atom *atom)
	Set the atom pointer.
Assignment
void	operator= (const Peak &peak)
	Assignment Operator.
Predicates
bool	operator== (const Peak< PositionType > &peak) const
	Equality operator.
bool	operator< (const Peak< PositionType > &peak) const
	Lesser than operator.
bool	operator> (const Peak< PositionType > &peak) const
	Greater than operator.
Protected Attributes
Position	position_
Position	width_
float	intensity_
const Atom *	atom_

---

Detailed Description

template<typename PositionType>
class Peak< PositionType >

Generic Peak Class.

Each peak contains a pointer to an associated atom (in the case of NMR: the atom that causes this peak).

---

Member Function Documentation

template<typename PositionType> const Atom * Peak< PositionType >::getAtom (   )  const

Return the atom pointer.

template<typename PositionType> float Peak< PositionType >::getIntensity (   )  const

Return the peak intensity (amplitude).

template<typename PositionType> const Peak< PositionType >::Position & Peak< PositionType >::getPosition (   )  const

Return the peak position.

template<typename PositionType> const Peak< PositionType >::Position & Peak< PositionType >::getWidth (   )  const

Return the peak width.

template<typename PositionType> void Peak< PositionType >::setAtom (  const Atom *  atom  )

Set the atom pointer.

template<typename PositionType> void Peak< PositionType >::setPosition (  const Position &  position  )

Set the peak position.