SheafSystem  0.0.0.0
constant_implicit_index_space_iterator.h
Go to the documentation of this file.
1 
2 //
3 // Copyright (c) 2014 Limit Point Systems, Inc.
4 //
5 // Licensed under the Apache License, Version 2.0 (the "License");
6 // you may not use this file except in compliance with the License.
7 // You may obtain a copy of the License at
8 //
9 // http://www.apache.org/licenses/LICENSE-2.0
10 //
11 // Unless required by applicable law or agreed to in writing, software
12 // distributed under the License is distributed on an "AS IS" BASIS,
13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 // See the License for the specific language governing permissions and
15 // limitations under the License.
16 //
17 
20 
21 #ifndef CONSTANT_IMPLICIT_INDEX_SPACE_ITERATOR_H
22 #define CONSTANT_IMPLICIT_INDEX_SPACE_ITERATOR_H
23 
24 #ifndef SHEAF_DLL_SPEC_H
25 #include "SheafSystem/sheaf_dll_spec.h"
26 #endif
27 
28 #ifndef AUTO_BLOCK_H
29 #include "SheafSystem/auto_block.h"
30 #endif
31 
32 #ifndef IMPLICIT_INDEX_SPACE_ITERATOR_H
33 #include "SheafSystem/implicit_index_space_iterator.h"
34 #endif
35 
36 namespace sheaf
37 {
38 
44 {
45 
46  friend class constant_implicit_index_space_interval;
47 
48  // ===========================================================
50  // ===========================================================
52 
53 public:
54 
59 
64 
69  pod_type xindex);
70 
75  const std::string& xname);
76 
81 
86 
87 protected:
88 
92  pod_type _hub_begin;
93 
94 private:
95 
97 
98 
99  // ===========================================================
101  // ===========================================================
103 
104 public:
105 
106 protected:
107 
108 private:
109 
111 
112 
113  // ===========================================================
115  // ===========================================================
116 
117 public:
118 
122  virtual constant_implicit_index_space_iterator& operator=(const index_space_iterator& xother);
123 
127  virtual bool operator==(const index_space_iterator& xother) const;
128 
133  virtual constant_implicit_index_space_iterator* clone() const;
134 
135 protected:
136 
137 private:
138 
140 
141 
142  // ===========================================================
144  // ===========================================================
146 
147 public:
148 
152  virtual void next();
153 
157  virtual void reset();
158 
159 protected:
160 
161 private:
162 
164 
165 
166  // ===========================================================
168  // ===========================================================
170 
171 public:
172 
174 
179  virtual void attach_to(const index_space_collection& xhost,
180  pod_type xlocal_id);
181 
183 
188  virtual bool conforms_to_state(const index_space_collection& xhost,
189  pod_type xlocal_id) const;
190 
191 protected:
192 
193 private:
194 
196 
197 
198  // ===========================================================
200  // ===========================================================
202 
203 public:
204 
208  virtual bool is_ancestor_of(const any *other) const;
209 
213  virtual bool invariant() const;
214 
215 protected:
216 
217 private:
218 
220 
221 };
222 
223 // ===========================================================
224 // NON-MEMBER FUNCTIONS
225 // ===========================================================
226 
227 
228 } // namespace sheaf
229 
230 #endif // ifndef CONSTANT_IMPLICIT_INDEX_SPACE_ITERATOR_H
An abstract iterator over the ids of an id space.
An implementation of implicit_index_space_iterator for an implicit id space in an constant_index_spac...
Abstract base class with useful features for all objects.
Definition: any.h:39
An implementation of class index_space_iterator for id spaces that are implicitly represtented...
virtual void attach_to(pod_type xindex)
Attach to the state with index xindex in the id space family id_spaces().
A collection of id space states. This is a virtual class with provides an interface for accessing the...
bool operator==(const singly_linked_list< T, Alloc > &lhs, const singly_linked_list< T, Alloc > &rhs)
Checks if the contents of lhs and rhs are equal, that is, whether lhs.size() == rhs.size() and each element in lhs compares equal with the element in rhs at the same position.
Namespace for the sheaves component of the sheaf system.
Factory and container for a family of id spaces.
bool conforms_to_state(const index_space_family &xid_spaces, pod_type xindex) const
True if this conforms to the handle type required by the state with index xindex in the id space fami...