itkTreeContainer.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 __itkTreeContainer_h
#define __itkTreeContainer_h

#include "itkTreeContainerBase.h"
#include "itkPreOrderTreeIterator.h"

namespace itk
{
template< class TValueType >
class TreeContainer:public TreeContainerBase< TValueType >
{
public:

  typedef TreeContainerBase< TValueType > Superclass;
  typedef TreeContainer< TValueType >     Self;
  typedef SmartPointer< Self >            Pointer;
  typedef SmartPointer< const Self >      ConstPointer;
  typedef TValueType                      ValueType;
  typedef TreeNode< ValueType >           TreeNodeType;

  typedef TreeIteratorBase< Self >     IteratorType;
  typedef PreOrderTreeIterator< Self > PreOrderIteratorType;

  itkNewMacro(Self);

  itkTypeMacro(TreeContainer, TreeContainerBase);

  TreeContainer(int defaultChildrenCount);

  TreeContainer(TreeContainer< TValueType > & tree);

  virtual bool SetRoot(const TValueType element);

  bool SetRoot(IteratorType & pos);

  virtual bool SetRoot(TreeNode< TValueType > *node);

  bool Contains(const TValueType element);

  int Count() const;

  bool IsLeaf(const TValueType element);

  bool IsRoot(const TValueType element);

  bool Clear();

  bool operator==(TreeContainer< TValueType > & tree);

  bool Swap(IteratorType & v, IteratorType & w);

  const TreeNodeType * GetRoot() const { return m_Root.GetPointer(); }

  bool Add(const TValueType child, const TValueType parent);

  const TreeNodeType * GetNode(TValueType val) const;

protected:

  TreeContainer();
  virtual ~TreeContainer();

  typename TreeNodeType::Pointer m_Root;

  int m_DefaultChildrenCount;

  void PrintSelf(std::ostream & os, Indent indent) const;
};
} // namespace itk

// Define instantiation macro for this template.
#define ITK_TEMPLATE_TreeContainer(_, EXPORT, TypeX, TypeY)     \
  namespace itk                                                 \
  {                                                             \
  _( 1 ( class EXPORT TreeContainer< ITK_TEMPLATE_1 TypeX > ) ) \
  namespace Templates                                           \
  {                                                             \
  typedef TreeContainer< ITK_TEMPLATE_1 TypeX >                 \
  TreeContainer##TypeY;                                       \
  }                                                             \
  }

#if ITK_TEMPLATE_EXPLICIT
#include "Templates/itkTreeContainer+-.h"
#endif

#if ITK_TEMPLATE_TXX
#include "itkTreeContainer.hxx"
#endif

#endif