vtkDataObjectTree.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkDataObjectTree.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/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 notice for more information.

=========================================================================*/
#ifndef vtkDataObjectTree_h
#define vtkDataObjectTree_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkCompositeDataSet.h"

class vtkCompositeDataIterator;
class vtkDataObjectTreeIterator;
class vtkDataObjectTreeInternals;
class vtkInformation;
class vtkInformationStringKey;
class vtkDataObject;

class VTKCOMMONDATAMODEL_EXPORT vtkDataObjectTree : public vtkCompositeDataSet
{
public:
  vtkTypeMacro(vtkDataObjectTree, vtkCompositeDataSet);
  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;

  virtual vtkDataObjectTreeIterator* NewTreeIterator();

  VTK_NEWINSTANCE vtkCompositeDataIterator* NewIterator() VTK_OVERRIDE;

  void CopyStructure(vtkCompositeDataSet* input) VTK_OVERRIDE;

  void SetDataSet(vtkCompositeDataIterator* iter,
                  vtkDataObject* dataObj) VTK_OVERRIDE;

  void SetDataSetFrom(vtkDataObjectTreeIterator* iter, vtkDataObject* dataObj);

  vtkDataObject* GetDataSet(vtkCompositeDataIterator* iter) VTK_OVERRIDE;

  virtual vtkInformation* GetMetaData(vtkCompositeDataIterator* iter);

  virtual int HasMetaData(vtkCompositeDataIterator* iter);

  unsigned long GetActualMemorySize() VTK_OVERRIDE;

  void Initialize() VTK_OVERRIDE;


  void ShallowCopy(vtkDataObject *src) VTK_OVERRIDE;
  void DeepCopy(vtkDataObject *src) VTK_OVERRIDE;

  vtkIdType GetNumberOfPoints() VTK_OVERRIDE;


  static vtkDataObjectTree* GetData(vtkInformation* info);
  static vtkDataObjectTree* GetData(vtkInformationVector* v, int i=0);

protected:
  vtkDataObjectTree();
  ~vtkDataObjectTree() VTK_OVERRIDE;

  void SetNumberOfChildren(unsigned int num);

  unsigned int GetNumberOfChildren();

  void SetChild(unsigned int index, vtkDataObject*);

  void RemoveChild(unsigned int index);

  vtkDataObject* GetChild(unsigned int num);

  vtkInformation* GetChildMetaData(unsigned int index);

  void SetChildMetaData(unsigned int index, vtkInformation* info);

  int HasChildMetaData(unsigned int index);

  // The internal datastructure. Subclasses need not access this directly.
  vtkDataObjectTreeInternals* Internals;

  friend class vtkDataObjectTreeIterator;

private:
  vtkDataObjectTree(const vtkDataObjectTree&) VTK_DELETE_FUNCTION;
  void operator=(const vtkDataObjectTree&) VTK_DELETE_FUNCTION;

};

#endif