← Back to branch summary

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

« back to all changes in this revision

Viewing changes to include/OpenMS/DATASTRUCTURES/CVReference.h

  • Committer: Package Import Robot
  • Author(s): Filippo Rusconi
  • Date: 2013-12-20 11:30:16 UTC
  • mfrom: (5.1.2 sid)
  • Revision ID: package-import@ubuntu.com-20131220113016-wre5g9bteeheq6he
Tags: 1.11.1-3
* remove version number from libbost development package names;
* ensure that AUTHORS is correctly shipped in all packages.

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/OpenMS/DATASTRUCTURES/CVReference.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
 
1
// --------------------------------------------------------------------------
 
2
//                   OpenMS -- Open-Source Mass Spectrometry
 
3
// --------------------------------------------------------------------------
 
4
// Copyright The OpenMS Team -- Eberhard Karls University Tuebingen,
 
5
// ETH Zurich, and Freie Universitaet Berlin 2002-2013.
 
6
//
 
7
// This software is released under a three-clause BSD license:
 
8
//  * Redistributions of source code must retain the above copyright
 
9
//    notice, this list of conditions and the following disclaimer.
 
10
//  * Redistributions in binary form must reproduce the above copyright
 
11
//    notice, this list of conditions and the following disclaimer in the
 
12
//    documentation and/or other materials provided with the distribution.
 
13
//  * Neither the name of any author or any participating institution
 
14
//    may be used to endorse or promote products derived from this software
 
15
//    without specific prior written permission.
 
16
// For a full list of authors, refer to the file AUTHORS.
 
17
// --------------------------------------------------------------------------
 
18
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 
19
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 
20
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 
21
// ARE DISCLAIMED. IN NO EVENT SHALL ANY OF THE AUTHORS OR THE CONTRIBUTING
 
22
// INSTITUTIONS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 
23
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 
24
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 
25
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 
26
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 
27
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 
28
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22
29
//
23
30
// --------------------------------------------------------------------------
24
31
// $Maintainer: Andreas Bertsch $
35
42
 
36
43
namespace OpenMS
37
44
{
38
 
        /**
39
 
                @brief Controlled Vocabulary Reference
40
 
                
41
 
                Reference to a controlled vocabulary, defined in the first section of a mapping file.
42
 
                
43
 
                @ingroup Datastructures
44
 
        */
45
 
 
46
 
                        class OPENMS_DLLAPI CVReference
47
 
                        {
48
 
                                public:
49
 
 
50
 
                                /// Default constructor
51
 
                                CVReference();
52
 
 
53
 
                                /// Copy constructor
54
 
                                CVReference(const CVReference& rhs);
55
 
 
56
 
                                /// Destructor
57
 
                                virtual ~CVReference();
58
 
 
59
 
                                /// Assignment operator
60
 
                                CVReference& operator = (const CVReference& rhs);
61
 
 
62
 
                                /** @name Accessors
63
 
                                */
64
 
                                //@{
65
 
                                /// sets the name of the CV reference
66
 
                                void setName(const String& name);
67
 
 
68
 
                                /// returns the name of the CV reference
69
 
                                const String& getName() const;
70
 
 
71
 
                                /// sets the CV identifier which is referenced
72
 
                                void setIdentifier(const String& identifier);
73
 
 
74
 
                                /// returns the CV identifier which is referenced
75
 
                                const String& getIdentifier() const;
76
 
                                //@}
77
 
 
78
 
                                /** @name Predicates
79
 
                                */
80
 
                                //@{
81
 
                                /// equality operator 
82
 
                                bool operator == (const CVReference& rhs) const;
83
 
                                
84
 
                                /// inequality operator
85
 
                                bool operator != (const CVReference& rhs) const;
86
 
                                //@}
87
 
 
88
 
 
89
 
                                protected:
90
 
 
91
 
                                String name_;
92
 
 
93
 
                                String identifier_;
94
 
                        };
95
 
                        
96
 
                        
 
45
  /**
 
46
      @brief Controlled Vocabulary Reference
 
47
 
 
48
      Reference to a controlled vocabulary, defined in the first section of a mapping file.
 
49
 
 
50
      @ingroup Datastructures
 
51
  */
 
52
 
 
53
  class OPENMS_DLLAPI CVReference
 
54
  {
 
55
public:
 
56
 
 
57
    /// Default constructor
 
58
    CVReference();
 
59
 
 
60
    /// Copy constructor
 
61
    CVReference(const CVReference & rhs);
 
62
 
 
63
    /// Destructor
 
64
    virtual ~CVReference();
 
65
 
 
66
    /// Assignment operator
 
67
    CVReference & operator=(const CVReference & rhs);
 
68
 
 
69
    /** @name Accessors
 
70
    */
 
71
    //@{
 
72
    /// sets the name of the CV reference
 
73
    void setName(const String & name);
 
74
 
 
75
    /// returns the name of the CV reference
 
76
    const String & getName() const;
 
77
 
 
78
    /// sets the CV identifier which is referenced
 
79
    void setIdentifier(const String & identifier);
 
80
 
 
81
    /// returns the CV identifier which is referenced
 
82
    const String & getIdentifier() const;
 
83
    //@}
 
84
 
 
85
    /** @name Predicates
 
86
    */
 
87
    //@{
 
88
    /// equality operator
 
89
    bool operator==(const CVReference & rhs) const;
 
90
 
 
91
    /// inequality operator
 
92
    bool operator!=(const CVReference & rhs) const;
 
93
    //@}
 
94
 
 
95
 
 
96
protected:
 
97
 
 
98
    String name_;
 
99
 
 
100
    String identifier_;
 
101
  };
 
102
 
 
103
 
97
104
} // namespace OpenMS
98
105
 
99
106
#endif // OPENMS_DATASTRUCTURES_CVREFERENCE_H