itkIndexedContainerInterface.h

Go to the documentation of this file.

/*=========================================================================
 *
 *  Copyright Insight Software Consortium
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0.txt
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *=========================================================================*/
#ifndef itkIndexedContainerInterface_h
#define itkIndexedContainerInterface_h

#include "itkObject.h"

namespace itk
{
template< typename TElementIdentifier, typename TElement >
class IndexedContainerInterface:public Object
{
public:
  using Self = IndexedContainerInterface;
  using Superclass = Object;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;

  itkTypeMacro(IndexedContainerInterface, Object);

  using ElementIdentifier = TElementIdentifier;
  using Element = TElement;

  Element & ElementAt(ElementIdentifier);

  Element & CreateElementAt(ElementIdentifier);

  Element GetElement(ElementIdentifier) const;

  void SetElement(ElementIdentifier, Element);

  void InsertElement(ElementIdentifier, Element);

  bool IndexExists(ElementIdentifier) const;

  bool GetElementIfIndexExists(ElementIdentifier, Element *) const;

  void CreateIndex(ElementIdentifier);

  void DeleteIndex(ElementIdentifier);

  class Iterator {};

  class ConstIterator {};

  Iterator Begin();

  Iterator End();

  ConstIterator Begin() const;

  ConstIterator End() const;

  ElementIdentifier Size() const;

  void Reserve(ElementIdentifier);

  void Squeeze();

  void Initialize();
};
} // end namespace itk

#endif