itkChildTreeIterator.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 __itkChildTreeIterator_h
#define __itkChildTreeIterator_h

#include "itkTreeIteratorBase.h"

namespace itk
{
template< class TTreeType >
class ChildTreeIterator:public TreeIteratorBase< TTreeType >
{
public:

  typedef ChildTreeIterator                       Self;
  typedef TreeIteratorBase< TTreeType >           Superclass;
  typedef TTreeType                               TreeType;
  typedef typename TTreeType::ValueType           ValueType;
  typedef typename Superclass::TreeNodeType       TreeNodeType;
  typedef typename TreeNodeType::ChildIdentifier  ChildIdentifier;
  typedef typename Superclass::NodeType           NodeType;

  ChildTreeIterator(TreeType *tree, const TreeNodeType *start = NULL);

  ChildTreeIterator(const TreeIteratorBase< TTreeType > & iterator);

  NodeType GetType() const;

  virtual bool GoToChild(ChildIdentifier number = 0);

  virtual bool GoToParent();

  TreeIteratorBase< TTreeType > * Clone();

  Self & operator=(Superclass & iterator)
  {
    Superclass::operator=(iterator);
    ChildTreeIterator< TTreeType > & it =
      static_cast< ChildTreeIterator< TTreeType > & >( iterator );
    m_ListPosition = it.m_ListPosition;
    m_ParentNode = it.m_ParentNode;
    return *this;
  }

protected:

  const ValueType & Next();

  bool HasNext() const;

private:

  mutable ChildIdentifier  m_ListPosition;
  TreeNodeType *           m_ParentNode;
};

} // end namespace itk

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

#endif