FreeNOS
Iterator.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2015 Niek Linnenbank
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program. If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef __LIBSTD_ITERATOR_H
19 #define __LIBSTD_ITERATOR_H
20 
21 #include "Types.h"
22 
34 template <class T> class Iterator
35 {
36  public:
37 
41  virtual ~Iterator() {}
42 
46  virtual void reset() = 0;
47 
53  virtual bool hasNext() const = 0;
54 
60  virtual bool hasCurrent() const = 0;
61 
67  virtual const T & current() const = 0;
68 
74  virtual T & current() = 0;
75 
84  virtual T & next() = 0;
85 
91  virtual bool remove() = 0;
92 
99  virtual void operator ++(int num) = 0;
100 };
101 
107 #endif /* __LIBSTD_ITERATOR_H */
Iterator::next
virtual T & next()=0
Fetch the next item modifiable.
Types.h
Iterator::current
virtual const T & current() const =0
Get the current item read-only.
Iterator
Abstracts an iteration process.
Definition: Iterator.h:34
Iterator::operator++
virtual void operator++(int num)=0
Increment operator.
Iterator::~Iterator
virtual ~Iterator()
Destructor.
Definition: Iterator.h:41
Iterator::reset
virtual void reset()=0
Restart iteration from the beginning.
Iterator::hasNext
virtual bool hasNext() const =0
Check if there is more to iterate.
Iterator::hasCurrent
virtual bool hasCurrent() const =0
Check if there is a current item.
Iterator::remove
virtual bool remove()=0
Remove the current item from the underlying Container.