Cortex  10.0.0-a4
CircularIterator.h
1 //
3 // Copyright (c) 2008-2011, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IECORE_CIRCULARITERATOR_H
36 #define IECORE_CIRCULARITERATOR_H
37 
38 namespace IECore
39 {
40 
49 template<typename Iterator, typename Container=void>
51 {
52 
53  public :
54 
55  typedef Iterator BaseIterator;
56  typedef typename BaseIterator::pointer pointer;
57  typedef typename BaseIterator::reference reference;
58  typedef typename BaseIterator::value_type value_type;
59 
65  CircularIterator( BaseIterator begin, BaseIterator end );
67  CircularIterator( BaseIterator begin, BaseIterator end, BaseIterator position );
72  CircularIterator( Container *container );
74  CircularIterator( Container *container, BaseIterator position );
75 
76  CircularIterator &operator++();
77  CircularIterator operator++( int );
78 
79  reference operator*() const;
80  pointer operator->() const;
81 
82  bool operator==( const CircularIterator &rhs ) const;
83  bool operator==( const BaseIterator &rhs ) const;
84 
85  bool operator!=( const CircularIterator &rhs ) const;
86  bool operator!=( const BaseIterator &rhs ) const;
87 
88  operator BaseIterator() const;
89 
90  CircularIterator &operator=( const BaseIterator &rhs );
91 
92  private :
93 
94  BaseIterator begin();
95  BaseIterator end();
96 
97  Container *m_container;
98  BaseIterator m_begin;
99  BaseIterator m_end;
100  BaseIterator m_it;
101 
102 };
103 
104 } // namespace IECore
105 
106 #include "IECore/CircularIterator.inl"
107 
108 #endif // IECORE_CIRCULARITERATOR_H
CircularIterator()
Uninitialised.
Definition: CircularIterator.h:50
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43