ITK  5.0.0
Insight Segmentation and Registration Toolkit
itkIndexedContainerInterface.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright Insight Software Consortium
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.txt
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  *=========================================================================*/
18 #ifndef itkIndexedContainerInterface_h
19 #define itkIndexedContainerInterface_h
20 
21 #include "itkObject.h"
22 
23 namespace itk
24 {
52 template< typename TElementIdentifier, typename TElement >
54 {
55 public:
58  using Superclass = Object;
61 
63  itkTypeMacro(IndexedContainerInterface, Object);
64 
66  using ElementIdentifier = TElementIdentifier;
67  using Element = TElement;
68 
76 
84 
87 
92 
97 
100  bool IndexExists(ElementIdentifier) const;
101 
108 
114 
122 
131  class Iterator {};
132 
141  class ConstIterator {};
142 
144  Iterator Begin();
145 
147  Iterator End();
148 
150  ConstIterator Begin() const;
151 
153  ConstIterator End() const;
154 
156  ElementIdentifier Size() const;
157 
163 
167  void Squeeze();
168 
171  void Initialize();
172 };
173 } // end namespace itk
174 
175 #endif
This should only be used for reference when writing containers conforming to this interface...
void SetElement(ElementIdentifier, Element)
void Reserve(ElementIdentifier)
bool GetElementIfIndexExists(ElementIdentifier, Element *) const
void CreateIndex(ElementIdentifier)
Element & ElementAt(ElementIdentifier)
void DeleteIndex(ElementIdentifier)
Support const iteration operations through a container. Dereferencing the iterator must provide an ob...
ElementIdentifier Size() const
bool IndexExists(ElementIdentifier) const
Element GetElement(ElementIdentifier) const
Element & CreateElementAt(ElementIdentifier)
void InsertElement(ElementIdentifier, Element)
Support iteration operations through a container. Dereferencing the iterator must provide an object w...
Base class for most ITK classes.
Definition: itkObject.h:60