bpp-popgen  3.0.0
BasicAlleleInfo.h
Go to the documentation of this file.
1 //
2 // File BasicAlleleInfo.h
3 // Author : Sylvain Gaillard
4 // Last modification : Thursday July 29 2004
5 //
6 
7 /*
8  Copyright or © or Copr. CNRS, (November 17, 2004)
9 
10  This software is a computer program whose purpose is to provide classes
11  for population genetics analysis.
12 
13  This software is governed by the CeCILL license under French law and
14  abiding by the rules of distribution of free software. You can use,
15  modify and/ or redistribute the software under the terms of the CeCILL
16  license as circulated by CEA, CNRS and INRIA at the following URL
17  "http://www.cecill.info".
18 
19  As a counterpart to the access to the source code and rights to copy,
20  modify and redistribute granted by the license, users are provided only
21  with a limited warranty and the software's author, the holder of the
22  economic rights, and the successive licensors have only limited
23  liability.
24 
25  In this respect, the user's attention is drawn to the risks associated
26  with loading, using, modifying and/or developing or reproducing the
27  software by the user in light of its specific status of free software,
28  that may mean that it is complicated to manipulate, and that also
29  therefore means that it is reserved for developers and experienced
30  professionals having in-depth computer knowledge. Users are therefore
31  encouraged to load and test the software's suitability as regards their
32  requirements in conditions enabling the security of their systems and/or
33  data to be ensured and, more generally, to use and operate it in the
34  same conditions as regards security.
35 
36  The fact that you are presently reading this means that you have had
37  knowledge of the CeCILL license and that you accept its terms.
38  */
39 
40 #ifndef _BASICALLELEINFO_H_
41 #define _BASICALLELEINFO_H_
42 
43 // From local Pop
44 #include "AlleleInfo.h"
45 #include "GeneralExceptions.h"
46 
47 namespace bpp
48 {
57  public AlleleInfo
58 {
59 private:
60  std::string id_;
61 
62 public:
63  // Constructors and destructor
69  BasicAlleleInfo(const std::string& id);
70 
74  BasicAlleleInfo(const BasicAlleleInfo& allele);
75 
76  virtual ~BasicAlleleInfo();
77 
78 public:
79  // Methodes
83  virtual BasicAlleleInfo& operator=(const BasicAlleleInfo& allele);
84 
88  virtual bool operator==(const BasicAlleleInfo& allele) const;
89 
93  virtual bool operator!=(const BasicAlleleInfo& allele) const;
94 
99 #ifdef NO_VIRTUAL_COV
100  Clonable*
101 #else
103 #endif
104  clone() const { return new BasicAlleleInfo(*this); }
110  void setId(const std::string& allele_id);
111  const std::string& getId() const;
113 };
114 } // end of namespace bpp;
115 
116 #endif // _BASICALLELEINFO_H_
117 
The AlleleInfo interface.
Definition: AlleleInfo.h:60
The BasicAlleleInfo class.
const std::string & getId() const
Get the identitier of the allele.
void setId(const std::string &allele_id)
Set the identifier of the allele.
BasicAlleleInfo * clone() const
BasicAlleleInfo(const std::string &id)
Build a new allele.
virtual bool operator==(const BasicAlleleInfo &allele) const
The == operator.
virtual bool operator!=(const BasicAlleleInfo &allele) const
The != operator.
virtual BasicAlleleInfo & operator=(const BasicAlleleInfo &allele)
The assignation operator.