BALL::Peak< PositionType > Class Template Reference

#include <BALL/NMR/peak.h>

Inheritance diagram for BALL::Peak< PositionType >:
BALL::PropertyManager

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 PositiongetPosition () const
const PositiongetWidth () const
float getIntensity () const
void setPosition (const Position &position)
void setWidth (const Position &width)
void setIntensity (float intensity)
const AtomgetAtom () 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 Atomatom_

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 ( )

Default Constructor

template<typename PositionType >
BALL::Peak< PositionType >::Peak ( const Peak< PositionType > &  peak)

Copy Constructor

template<typename PositionType >
BALL::Peak< PositionType >::~Peak ( ) [virtual]

Destructor


Member Function Documentation

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

Return the atom pointer.

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

Return the peak intensity (amplitude).

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

Return the peak position.

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

Return the peak width.

template<typename PositionType>
bool BALL::Peak< PositionType >::operator< ( const Peak< PositionType > &  peak) const

Lesser than operator

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

template<typename PositionType >
void BALL::Peak< PositionType >::operator= ( const Peak< PositionType > &  peak)
template<typename PositionType>
bool BALL::Peak< PositionType >::operator== ( const Peak< PositionType > &  peak) const
template<typename PositionType>
bool BALL::Peak< PositionType >::operator> ( const Peak< PositionType > &  peak) const

Greater than operator

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

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

Set the atom pointer.

template<typename PositionType >
BALL_INLINE void BALL::Peak< PositionType >::setIntensity ( float  intensity)

Set the peak height

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]
template<typename PositionType>
float BALL::Peak< PositionType >::intensity_ [protected]
template<typename PositionType>
Position BALL::Peak< PositionType >::width_ [protected]