bpp-seq  2.2.0
SiteContainerIterator.h
Go to the documentation of this file.
1 //
2 // File: SiteContainerIterator.h
3 // Created by: Julien Dutheil
4 // Created on: Sun Oct 19 12:47:16 2003
5 //
6 
7 /*
8 Copyright or © or Copr. Bio++ Development Team, (November 17, 2004)
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 _SITECONTAINERITERATOR_H_
41 #define _SITECONTAINERITERATOR_H_
42 
43 #include "../Site.h"
44 #include "../SiteIterator.h"
45 #include "SiteContainer.h"
46 
47 namespace bpp
48 {
49 
54  public virtual ConstSiteIterator
55 {
56  protected:
59 
60  public:
62 
64  sites_(asi.sites_),
66 
68  {
69  sites_ = asi.sites_;
71  return *this;
72  }
73 
75 
76 };
77 
82 {
83  public:
86 
87  public:
88  const Site* nextSite();
89  bool hasMoreSites() const;
90 };
91 
96 {
97  public:
100 
101  public:
102  const Site* nextSite();
103  bool hasMoreSites() const;
104  int nextSiteWithoutGapPosition(int current) const;
105  int previousSiteWithoutGapPosition(int current) const;
106 };
107 
113 {
114  public:
117 
118  public:
119  const Site * nextSite();
120  bool hasMoreSites() const;
121  int nextCompleteSitePosition(int current) const;
122  int previousCompleteSitePosition(int current) const;
123 };
124 
125 } //end of namespace bpp.
126 
127 #endif //_SITEITERATOR_H_
128 
Partial implementation of the SiteIterator interface, allowing to loop over a site container...
AbstractSiteContainerIterator(const AbstractSiteContainerIterator &asi)
The SiteContainer interface.
Definition: SiteContainer.h:63
Loop over all sites in a SiteContainer.
AbstractSiteContainerIterator & operator=(const AbstractSiteContainerIterator &asi)
This alphabet is used to deal NumericAlphabet.
SimpleSiteContainerIterator(const SiteContainer &sites)
Loop over all complete sites in a SiteContainer (i.e. sites without gap and unresolved characters)...
CompleteSiteContainerIterator(const SiteContainer &sites)
Generic const site iterator interface, allowing to loop over const sites.
Definition: SiteIterator.h:65
AbstractSiteContainerIterator(const SiteContainer &sites)
int nextSiteWithoutGapPosition(int current) const
Loop over all sites without gaps in a SiteContainer.
int previousCompleteSitePosition(int current) const
int previousSiteWithoutGapPosition(int current) const
NoGapSiteContainerIterator(const SiteContainer &sites)
The Site class.
Definition: Site.h:61