SheafSystem  0.0.0.0
array_index_space_handle.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 ARRAY_INDEX_SPACE_HANDLE_H
22 #define ARRAY_INDEX_SPACE_HANDLE_H
23 
24 #ifndef SHEAF_DLL_SPEC_H
25 #include "SheafSystem/sheaf_dll_spec.h"
26 #endif
27 
28 #ifndef SCATTERED_INSERTION_INDEX_SPACE_HANDLE_H
29 #include "SheafSystem/scattered_insertion_index_space_handle.h"
30 #endif
31 
32 namespace sheaf
33 {
34 
35 class array_index_space_state;
36 
47 {
48 
49  friend class array_index_space_state;
50 
51  // ===========================================================
53  // ===========================================================
55 
56 public:
57 
63  static array_index_space_handle new_space(index_space_family& xid_spaces,
64  const std::string& xname,
65  bool xis_persistent,
66  size_type xcapacity);
67 
68 protected:
69 
70 private:
71 
73 
74 
75  // ===========================================================
77  // ===========================================================
79 
80 public:
81 
86 
91 
96  pod_type xindex);
97 
102  const std::string& xname);
103 
108  array_index_space_handle& operator=(const array_index_space_handle& xother);
109 
113  virtual ~array_index_space_handle();
114 
115 protected:
116 
121 
123 
127  array_index_space_state& state();
128 
132  const array_index_space_state& state() const;
133 
134 private:
135 
137 
138 
139  // ===========================================================
141  // ===========================================================
143 
144 public:
145 
146 protected:
147 
148 private:
149 
151 
152 
153  // ===========================================================
155  // ===========================================================
157 
158 public:
159 
160 protected:
161 
162 private:
163 
165 
166 
167  // ===========================================================
169  // ===========================================================
171 
172 public:
173 
178  virtual array_index_space_handle& operator=(const index_space_handle& xother);
179 
184  virtual array_index_space_handle* clone() const;
185 
186 protected:
187 
188 private:
189 
191 
192 
193  // ===========================================================
195  // ===========================================================
197 
198 public:
199 
201 
206  virtual bool conforms_to_state(const index_space_collection& xhost,
207  pod_type xlocal_id) const;
208 
209 protected:
210 
211 private:
212 
214 
215 
216  // ===========================================================
218  // ===========================================================
220 
221 public:
222 
226  virtual bool is_ancestor_of(const any *other) const;
227 
231  virtual bool invariant() const;
232 
233 protected:
234 
235 private:
236 
238 
239 };
240 
241 // ===========================================================
242 // NON-MEMBER FUNCTIONS
243 // ===========================================================
244 
245 } // end namespace sheaf
246 
247 #endif // ifndef ARRAY_INDEX_SPACE_HANDLE_H
scattered_insertion_index_space_state & state()
The mutable id space state (mutable version).
An abstract handle to a space of alternate integer identifiers (aliases) for a subset of a hub set of...
An array implementation of class scattered_insertion_index_space_state. This representation is intend...
Abstract base class with useful features for all objects.
Definition: any.h:39
pod_index_type pod_type
The "plain old data" index type for this.
An array implementation of class scattered_insertion_index_space_handle. This representation is inten...
unsigned long size_type
An unsigned integral type used to represent sizes and capacities.
Definition: sheaf.h:52
A collection of id space states. This is a virtual class with provides an interface for accessing the...
virtual bool conforms_to_state(const index_space_collection &xhost, pod_type xlocal_id) const
True if this conforms to the handle type required by the state with local scope id xlocal_id in the h...
A handle for a scattered_insertion_index_space_state.
Namespace for the sheaves component of the sheaf system.
Factory and container for a family of id spaces.