bpp-seq  2.2.0
AlphabetState.h
Go to the documentation of this file.
1 //
2 // File: AlphabetState.h
3 // Author: Sylvain Gaillard
4 // Created: 29/07/2009 13:56:01
5 //
6 
7 /*
8 Copyright or © or Copr. Bio++ Development Team, (July 29, 2009)
9 
10 This software is a computer program whose purpose is to provide classes
11 for sequences 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 _ALPHABETSTATE_H_
41 #define _ALPHABETSTATE_H_
42 
43 #include <Bpp/Clonable.h>
44 
45 // From the STL
46 #include <string>
47 
48 namespace bpp {
54  class AlphabetState: public virtual Clonable {
55  private:
56  int num_;
57  std::string letter_;
58  std::string name_;
59 
60  public:
61  AlphabetState(int num, const std::string& letter, const std::string& name): num_(num), letter_(letter), name_(name) {}
62 
63  // Class destructor
64  virtual ~AlphabetState() {}
65 
66  public:
71 #ifdef NO_VIRTUAL_COV
72  Clonable*
73 #else
75 #endif
76  clone() const { return new AlphabetState(* this); }
83  int getNum() const { return num_; }
89  void setNum(int num) { num_ = num; }
90 
99  const std::string& getLetter() const { return letter_; }
105  void setLetter(const std::string& letter) { letter_ = letter; }
106 
112  const std::string& getName() const { return name_; }
118  void setName(const std::string& name) { name_ = name; }
119 
126  return getNum() == l2.getNum();
127  }
128  };
129 }
130 
131 #endif // _ALPHABETSTATE_H_
132 
This is the base class to describe states in an Alphabet.
Definition: AlphabetState.h:54
void setName(const std::string &name)
Set the name of the state.
int getNum() const
Get the state&#39;s number.
Definition: AlphabetState.h:83
This alphabet is used to deal NumericAlphabet.
AlphabetState * clone() const
Definition: AlphabetState.h:76
const std::string & getName() const
Get the name of the state.
const std::string & getLetter() const
Get the letter(s) corresponding to the state.
Definition: AlphabetState.h:99
virtual ~AlphabetState()
Definition: AlphabetState.h:64
bool operator==(AlphabetState &l2)
operator ==
std::string letter_
Definition: AlphabetState.h:57
void setNum(int num)
Set the state&#39;s number.
Definition: AlphabetState.h:89
std::string name_
Definition: AlphabetState.h:58
void setLetter(const std::string &letter)
Set the letter(s) of the state.
AlphabetState(int num, const std::string &letter, const std::string &name)
Definition: AlphabetState.h:61