ITK  5.2.0
Insight Toolkit
itkIndexedContainerInterface.h
Go to the documentation of this file.
1 /*=========================================================================
2  *
3  * Copyright NumFOCUS
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 
107  bool
109 
115 
123 
132  class Iterator
133  {};
134 
144  {};
145 
147  Iterator
148  Begin();
149 
151  Iterator
152  End();
153 
156  Begin() const;
157 
160  End() const;
161 
164  Size() const;
165 
171 
175  void
176  Squeeze();
177 
180  void
181  Initialize();
182 };
183 } // end namespace itk
184 
185 #endif
itk::IndexedContainerInterface::CreateIndex
void CreateIndex(ElementIdentifier)
itk::IndexedContainerInterface::Begin
Iterator Begin()
itk::IndexedContainerInterface::Initialize
void Initialize()
itk::IndexedContainerInterface::Reserve
void Reserve(ElementIdentifier)
itk::IndexedContainerInterface::ElementAt
Element & ElementAt(ElementIdentifier)
itk::IndexedContainerInterface::DeleteIndex
void DeleteIndex(ElementIdentifier)
itk::IndexedContainerInterface::Iterator
Support iteration operations through a container. Dereferencing the iterator must provide an object w...
Definition: itkIndexedContainerInterface.h:132
itk::SmartPointer< Self >
itk::IndexedContainerInterface::IndexExists
bool IndexExists(ElementIdentifier) const
itk::IndexedContainerInterface::ElementIdentifier
TElementIdentifier ElementIdentifier
Definition: itkIndexedContainerInterface.h:66
itk::IndexedContainerInterface::CreateElementAt
Element & CreateElementAt(ElementIdentifier)
itk::IndexedContainerInterface::End
Iterator End()
itk::IndexedContainerInterface::InsertElement
void InsertElement(ElementIdentifier, Element)
itk::IndexedContainerInterface
This should only be used for reference when writing containers conforming to this interface....
Definition: itkIndexedContainerInterface.h:53
itk::IndexedContainerInterface::ConstIterator
Support const iteration operations through a container. Dereferencing the iterator must provide an ob...
Definition: itkIndexedContainerInterface.h:143
itk::IndexedContainerInterface::SetElement
void SetElement(ElementIdentifier, Element)
itkObject.h
itk
The "itk" namespace contains all Insight Segmentation and Registration Toolkit (ITK) classes....
Definition: itkAnnulusOperator.h:24
itk::IndexedContainerInterface::Size
ElementIdentifier Size() const
itk::IndexedContainerInterface::Element
TElement Element
Definition: itkIndexedContainerInterface.h:67
itk::IndexedContainerInterface::GetElementIfIndexExists
bool GetElementIfIndexExists(ElementIdentifier, Element *) const
itk::Object
Base class for most ITK classes.
Definition: itkObject.h:60
itk::IndexedContainerInterface::GetElement
Element GetElement(ElementIdentifier) const
itk::Object::Object
Object()
itk::IndexedContainerInterface::Squeeze
void Squeeze()