itkTreeNode.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 itkTreeNode_h
#define itkTreeNode_h

#include <vector>
#include <algorithm>
#include <iostream>
#include "itkObject.h"
#include "itkObjectFactory.h"
#include "itkIntTypes.h"

namespace itk
{
template< typename TValue >
class ITK_TEMPLATE_EXPORT TreeNode:public Object
{
public:
  ITK_DISALLOW_COPY_AND_ASSIGN(TreeNode);

  using Superclass = Object;
  using Self = TreeNode< TValue >;
  using Pointer = SmartPointer< Self >;
  using ConstPointer = SmartPointer< const Self >;
  using ChildrenListType = std::vector< Pointer >;
  using ChildIdentifier = ::itk::OffsetValueType;

  itkNewMacro(Self);

  itkTypeMacro(TreeNode, Object);

  const TValue & Get() const;

  TValue Set(const TValue data);

  Self * GetChild(ChildIdentifier number) const;

  Self * GetParent() const;

  bool HasChildren() const;

  bool HasParent() const;

  void SetParent(Self *n);

  ChildIdentifier CountChildren() const;

  bool Remove(Self *n);

  ChildIdentifier GetNumberOfChildren(unsigned int depth = 0, char *name = nullptr) const;

  bool ReplaceChild(Self *oldChild, Self *newChild);

  ChildIdentifier ChildPosition(const Self *node) const;

  ChildIdentifier ChildPosition(TValue node) const;

  void AddChild(Self *node);

  virtual void AddChild(ChildIdentifier number, Self *node);

#if !defined( ITK_WRAPPING_PARSER )
  virtual ChildrenListType * GetChildren(unsigned int depth = 0, char *name = nullptr) const;

#endif

#if !defined( ITK_WRAPPING_PARSER )
  virtual ChildrenListType & GetChildrenList() { return m_Children; }
#endif

  //virtual void SetData(TValue data) {m_Data = data;}

protected:

  TreeNode() = default;
  ~TreeNode() override;

  TValue m_Data;
  Self *m_Parent{nullptr};

  ChildrenListType m_Children;
};
} // end namespace itk

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

#endif