itkTreeContainer.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile: itkTreeContainer.h,v $
  Language:  C++
  Date:      $Date: 2009-03-03 15:10:33 $
  Version:   $Revision: 1.5 $

  Copyright (c) Insight Software Consortium. All rights reserved.
  See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/
#ifndef __itkTreeContainer_h
#define __itkTreeContainer_h

#include "itkMacro.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, x, y) namespace itk { \
  _(1(class EXPORT TreeContainer< ITK_TEMPLATE_1 x >)) \
  namespace Templates { typedef TreeContainer< ITK_TEMPLATE_1 x > \
                                                  TreeContainer##y; } \
  }

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

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

#endif