← Back to branch summary

~ubuntu-branches/ubuntu/wily/openms/wily

« back to all changes in this revision

Viewing changes to include/OpenMS/KERNEL/DRichPeak.h

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2012-11-12 15:58:12 UTC
  • Revision ID: package-import@ubuntu.com-20121112155812-vr15wtg9b50cuesg
Tags: upstream-1.9.0
Import upstream version 1.9.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/OpenMS/KERNEL/DRichPeak.h
 
1
// -*- mode: C++; tab-width: 2; -*-
 
2
// vi: set ts=2:
 
3
//
 
4
// --------------------------------------------------------------------------
 
5
//                   OpenMS Mass Spectrometry Framework
 
6
// --------------------------------------------------------------------------
 
7
//  Copyright (C) 2003-2011 -- Oliver Kohlbacher, Knut Reinert
 
8
//
 
9
//  This library is free software; you can redistribute it and/or
 
10
//  modify it under the terms of the GNU Lesser General Public
 
11
//  License as published by the Free Software Foundation; either
 
12
//  version 2.1 of the License, or (at your option) any later version.
 
13
//
 
14
//  This library is distributed in the hope that it will be useful,
 
15
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
16
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 
17
//  Lesser General Public License for more details.
 
18
//
 
19
//  You should have received a copy of the GNU Lesser General Public
 
20
//  License along with this library; if not, write to the Free Software
 
21
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
22
//
 
23
// --------------------------------------------------------------------------
 
24
// $Maintainer: Clemens Groepl $
 
25
// $Authors: $
 
26
// --------------------------------------------------------------------------
 
27
 
 
28
#ifndef OPENMS_KERNEL_DRICHPEAK_H
 
29
#define OPENMS_KERNEL_DRICHPEAK_H
 
30
 
 
31
#include <OpenMS/KERNEL/RichPeak1D.h>
 
32
#include <OpenMS/KERNEL/RichPeak2D.h>
 
33
 
 
34
namespace OpenMS
 
35
{
 
36
        
 
37
        /**
 
38
                @brief Metafunction to choose among RichPeak1D respectively RichPeak2D through a template argument.
 
39
                
 
40
                The result is accessible via typedef Type.
 
41
                - @c DRichPeak<1>::Type is @c RichPeak1D
 
42
                - @c DRichPeak<2>::Type is @c RichPeak2D
 
43
        
 
44
                Example:
 
45
          @code
 
46
                template class BaseModel<UInt D>
 
47
                {
 
48
                        // BaseModel<D>::PeakType is either RichPeak1D or RichPeak2D, depending on D
 
49
                        typedef typename DRichPeak<D>::Type PeakType;
 
50
                };
 
51
                @endcode
 
52
        */
 
53
        template <UInt dimensions>
 
54
        struct DRichPeak
 
55
        {
 
56
        };
 
57
        
 
58
        // We do not want these classes to show up in the docu
 
59
        /// @cond HIDDENSTUFF
 
60
        
 
61
        template <>
 
62
        struct DRichPeak <1>
 
63
        {
 
64
                typedef RichPeak1D Type;
 
65
        };
 
66
 
 
67
        template <>
 
68
        struct DRichPeak <2>
 
69
        {
 
70
                typedef RichPeak2D Type;
 
71
        };
 
72
        
 
73
        /// @endcond
 
74
 
 
75
} // namespace OpenMS
 
76
 
 
77
#endif // OPENMS_KERNEL_DRICHPEAK_H