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

#include <BALL/NMR/peak.h>

Inheritance diagram for BALL::Peak< PositionType >:

List of all members.

Public Types
Typedefs
typedef PositionType	Position
Public Member Functions
Constructors and Destructors
	Peak ()
	Peak (const Peak &peak)
virtual	~Peak ()
Accessors
const Position &	getPosition () const
const Position &	getWidth () const
float	getIntensity () const
void	setPosition (const Position &position)
void	setWidth (const Position &width)
void	setIntensity (float intensity)
const Atom *	getAtom () const
void	setAtom (const Atom *atom)
Assignment
void	operator= (const Peak &peak)
Predicates
bool	operator== (const Peak< PositionType > &peak) const
bool	operator< (const Peak< PositionType > &peak) const
bool	operator> (const Peak< PositionType > &peak) const
Protected Attributes
Position	position_
Position	width_
float	intensity_
const Atom *	atom_

---

Detailed Description

template<typename PositionType>
class BALL::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 Typedef Documentation

template<typename PositionType>

typedef PositionType BALL::Peak< PositionType >::Position

---

Constructor & Destructor Documentation

template<typename PositionType >

BALL::Peak< PositionType >::Peak

(

)

[inline]

Default Constructor

template<typename PositionType >

BALL::Peak< PositionType >::Peak

(

const Peak< PositionType > &

peak

)

[inline]

Copy Constructor

template<typename PositionType >

BALL::Peak< PositionType >::~Peak

(

)

[inline, virtual]

Destructor

---

Member Function Documentation

template<typename PositionType >

BALL_INLINE const Atom * BALL::Peak< PositionType >::getAtom

(

)

const [inline]

Return the atom pointer.

References BALL::Peak< PositionType >::atom_.

template<typename PositionType >

BALL_INLINE float BALL::Peak< PositionType >::getIntensity

(

)

const [inline]

Return the peak intensity (amplitude).

References BALL::Peak< PositionType >::intensity_.

template<typename PositionType >

BALL_INLINE const Peak< PositionType >::Position & BALL::Peak< PositionType >::getPosition

(

)

const [inline]

Return the peak position.

References BALL::Peak< PositionType >::position_.

template<typename PositionType >

BALL_INLINE const Peak< PositionType >::Position & BALL::Peak< PositionType >::getWidth

(

)

const [inline]

Return the peak width.

References BALL::Peak< PositionType >::width_.

template<typename PositionType>

bool BALL::Peak< PositionType >::operator<

(

const Peak< PositionType > &

peak

)

const [inline]

Lesser than operator

References BALL::Peak< PositionType >::position_.

template<typename PositionType >

void BALL::Peak< PositionType >::operator=

(

const Peak< PositionType > &

peak

)

[inline]

Assignment Operator

References BALL::Peak< PositionType >::atom_, BALL::Peak< PositionType >::intensity_, BALL::Peak< PositionType >::position_, and BALL::Peak< PositionType >::width_.

template<typename PositionType>

bool BALL::Peak< PositionType >::operator==

(

const Peak< PositionType > &

peak

)

const [inline]

Equality operator

References BALL::Peak< PositionType >::atom_, BALL::Peak< PositionType >::intensity_, BALL::Peak< PositionType >::position_, and BALL::Peak< PositionType >::width_.

template<typename PositionType>

bool BALL::Peak< PositionType >::operator>

(

const Peak< PositionType > &

peak

)

const [inline]

Greater than operator

References BALL::Peak< PositionType >::position_.

template<typename PositionType >

BALL_INLINE void BALL::Peak< PositionType >::setAtom

(

const Atom *

atom

)

[inline]

Set the atom pointer.

References BALL::Peak< PositionType >::atom_.

template<typename PositionType >

BALL_INLINE void BALL::Peak< PositionType >::setIntensity

(

float

intensity

)

[inline]

Set the peak height

References BALL::Peak< PositionType >::intensity_.

template<typename PositionType>

void BALL::Peak< PositionType >::setPosition

(

const Position &

position

)

Set the peak position.

template<typename PositionType>

void BALL::Peak< PositionType >::setWidth

(

const Position &

width

)

Set the peak width

---

Member Data Documentation

template<typename PositionType>

const Atom* BALL::Peak< PositionType >::atom_ [protected]

Referenced by BALL::Peak< PositionType >::getAtom(), BALL::Peak< PositionType >::operator=(), BALL::Peak< PositionType >::operator==(), and BALL::Peak< PositionType >::setAtom().

template<typename PositionType>

float BALL::Peak< PositionType >::intensity_ [protected]

Referenced by BALL::Peak< PositionType >::getIntensity(), BALL::Peak< PositionType >::operator=(), BALL::Peak< PositionType >::operator==(), and BALL::Peak< PositionType >::setIntensity().

template<typename PositionType>

Position BALL::Peak< PositionType >::position_ [protected]

Referenced by BALL::Peak< PositionType >::getPosition(), BALL::Peak< PositionType >::operator<(), BALL::Peak< PositionType >::operator=(), BALL::Peak< PositionType >::operator==(), and BALL::Peak< PositionType >::operator>().

template<typename PositionType>

Position BALL::Peak< PositionType >::width_ [protected]

Referenced by BALL::Peak< PositionType >::getWidth(), BALL::Peak< PositionType >::operator=(), and BALL::Peak< PositionType >::operator==().