ITK  4.1.0
Insight Segmentation and Registration Toolkit
itkIndexedContainerInterface.h
Go to the documentation of this file.
00001 /*=========================================================================
00002  *
00003  *  Copyright Insight Software Consortium
00004  *
00005  *  Licensed under the Apache License, Version 2.0 (the "License");
00006  *  you may not use this file except in compliance with the License.
00007  *  You may obtain a copy of the License at
00008  *
00009  *         http://www.apache.org/licenses/LICENSE-2.0.txt
00010  *
00011  *  Unless required by applicable law or agreed to in writing, software
00012  *  distributed under the License is distributed on an "AS IS" BASIS,
00013  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  *  See the License for the specific language governing permissions and
00015  *  limitations under the License.
00016  *
00017  *=========================================================================*/
00018 #ifndef __itkIndexedContainerInterface_h
00019 #define __itkIndexedContainerInterface_h
00020 
00021 #include "itkObject.h"
00022 
00023 namespace itk
00024 {
00052 template< typename TElementIdentifier, typename TElement >
00053 class IndexedContainerInterface:public Object
00054 {
00055 public:
00057   typedef IndexedContainerInterface  Self;
00058   typedef Object                     Superclass;
00059   typedef SmartPointer< Self >       Pointer;
00060   typedef SmartPointer< const Self > ConstPointer;
00061 
00063   itkTypeMacro(IndexedContainerInterface, Object);
00064 
00066   typedef TElementIdentifier ElementIdentifier;
00067   typedef TElement           Element;
00068 
00075   Element & ElementAt(ElementIdentifier);
00076 
00083   Element & CreateElementAt(ElementIdentifier);
00084 
00086   Element GetElement(ElementIdentifier) const;
00087 
00091   void SetElement(ElementIdentifier, Element);
00092 
00096   void InsertElement(ElementIdentifier, Element);
00097 
00100   bool IndexExists(ElementIdentifier) const;
00101 
00107   bool GetElementIfIndexExists(ElementIdentifier, Element *) const;
00108 
00113   void CreateIndex(ElementIdentifier);
00114 
00121   void DeleteIndex(ElementIdentifier);
00122 
00131   class Iterator {};
00132 
00141   class ConstIterator {};
00142 
00144   Iterator Begin();
00145 
00147   Iterator End();
00148 
00150   ConstIterator Begin() const;
00151 
00153   ConstIterator End() const;
00154 
00156   ElementIdentifier Size(void) const;
00157 
00162   void Reserve(ElementIdentifier);
00163 
00167   void Squeeze(void);
00168 
00171   void Initialize(void);
00172 };
00173 } // end namespace itk
00174 
00175 #endif
00176