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 <typename TValue>
class ITK_TEMPLATE_EXPORT TreeContainer : public TreeContainerBase<TValue>
{
public:
  using Superclass = TreeContainerBase<TValue>;
  using Self = TreeContainer<TValue>;
  using Pointer = SmartPointer<Self>;
  using ConstPointer = SmartPointer<const Self>;
  using ValueType = TValue;
  using TreeNodeType = TreeNode<ValueType>;
 
  using IteratorType = TreeIteratorBase<Self>;
  using PreOrderIteratorType = PreOrderTreeIterator<Self>;
 
  itkNewMacro(Self);
 
  itkTypeMacro(TreeContainer, TreeContainerBase);
 
  TreeContainer(int defaultChildrenCount);
 
  TreeContainer(TreeContainer<TValue> & tree);
 
  bool
  SetRoot(const TValue element) override;
 
  bool
  SetRoot(IteratorType & pos);
 
  bool
  SetRoot(TreeNode<TValue> * node) override;
 
  bool
  Contains(const TValue element) override;
 
  int
  Count() const override;
 
  bool
  IsLeaf(const TValue element) override;
 
  bool
  IsRoot(const TValue element) override;
 
  bool
  Clear() override;
 
  bool
  operator==(TreeContainer<TValue> & tree);
 
  bool
  Swap(IteratorType & v, IteratorType & w);
 
  const TreeNodeType *
  GetRoot() const override
  {
    return m_Root.GetPointer();
  }
 
  bool
  Add(const TValue child, const TValue parent);
 
  const TreeNodeType *
  GetNode(TValue val) const;
 
protected:
  TreeContainer();
  ~TreeContainer() override = default;
 
  typename TreeNodeType::Pointer m_Root;
 
  int m_DefaultChildrenCount;
 
  void
  PrintSelf(std::ostream & os, Indent indent) const override;
};
} // namespace itk
 
#ifndef ITK_MANUAL_INSTANTIATION
#  include "itkTreeContainer.hxx"
#endif
 
#endif