Main Page | Modules | Namespace List | Class Hierarchy | Class List | Namespace Members | Class Members

Experiment< PeakListType > Class Template Reference
[NMR spectra and related classes]

Class describing a certain type of NMR experiment. More...

#include <experiment.h>

Inheritance diagram for Experiment< PeakListType >:

ShiftModule UnaryProcessor< Composite > UnaryFunctor< Composite, Processor::Result > List of all members.

Public Types

Typedefs
typedef PeakListType::PeakType PeakType
 The peak type.

Public Member Functions

Constructors and Destructors
 Experiment ()
 Default Constructor.
 Experiment (const Experiment &experiment)
 Copy constructor.
virtual ~Experiment () throw ()
 Destructor.
Accessors
const PeakListType & getPeakList () const
 Return the peak list.
const PeakTypegetDefaultPeak () const
 Return the default peak.
void setDefaultPeak (const PeakType &peak)
 Assign the default peak.

Protected Attributes

PeakListType peak_list_
PeakType default_peak_

Detailed Description

template<typename PeakListType>
class Experiment< PeakListType >

Class describing a certain type of NMR experiment.

This class (and its subclasses) are used to describe how a list of peaks is derived from the shifts calculated for a system.


Member Function Documentation

template<typename PeakListType>
const Experiment< PeakListType >::PeakType & Experiment< PeakListType >::getDefaultPeak  )  const
 

Return the default peak.

This peak can be assigned a default width and intensity that is assigned to all extracted peaks in the peak list. This is the default behaviour and can be overridden in derived classes.

template<typename PeakListType>
void Experiment< PeakListType >::setDefaultPeak const PeakType peak  ) 
 

Assign the default peak.

See also:
getDefaultPeak