/*=========================================================================
 *
 *  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 __itkLevelSetDomainPartitionBase_h
#define __itkLevelSetDomainPartitionBase_h

#include "itkObject.h"
#include "itkIntTypes.h"

#include <list>

namespace itk
{
/** \class LevelSetDomainPartitionBase
 *
 * \brief Helper class used to partition domain and efficiently compute overlap.
 * \ingroup ITKLevelSetsv4
 */
template< typename TDomain >
class LevelSetDomainPartitionBase : public Object
{
public:

  typedef LevelSetDomainPartitionBase           Self;
  typedef Object                                Superclass;
  typedef SmartPointer< Self >                  Pointer;
  typedef SmartPointer< const Self >            ConstPointer;

  itkTypeMacro(LevelSetDomainPartitionBase, LightObject);

  /** Get/Set the number of level set functions */
  itkSetMacro( NumberOfLevelSetFunctions, IdentifierType );
  itkGetMacro( NumberOfLevelSetFunctions, IdentifierType );

  virtual void PopulateListDomain() = 0;

protected:

  /** \brief Constructor */
  LevelSetDomainPartitionBase();

  /** \brief Destructor */
  virtual ~LevelSetDomainPartitionBase();

  virtual void AllocateListDomain() = 0;

  typedef std::list< IdentifierType >                 IdentifierListType;
  typedef typename IdentifierListType::iterator       IdentifierListIterator;
  typedef typename IdentifierListType::const_iterator IdentifierListConstIterator;

  IdentifierType m_NumberOfLevelSetFunctions;

private:
  LevelSetDomainPartitionBase(const Self &); // purposely not implemented
  void operator=(const Self &); // purposely not implemented
};
} //end namespace itk

#ifndef ITK_MANUAL_INSTANTIATION
#include "itkLevelSetDomainPartitionBase.hxx"
#endif

#endif
