vtkMutableDirectedGraph.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkMutableDirectedGraph.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.

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
#ifndef vtkMutableDirectedGraph_h
#define vtkMutableDirectedGraph_h

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

class vtkEdgeListIterator;
class vtkGraphEdge;
class vtkVariant;

class VTKCOMMONDATAMODEL_EXPORT vtkMutableDirectedGraph : public vtkDirectedGraph
{
public:
  static vtkMutableDirectedGraph *New();
  vtkTypeMacro(vtkMutableDirectedGraph, vtkDirectedGraph);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  virtual vtkIdType SetNumberOfVertices( vtkIdType numVerts );

  vtkIdType AddVertex();

  vtkIdType AddVertex(vtkVariantArray *propertyArr);

  vtkIdType AddVertex(const vtkVariant& pedigreeId);

  vtkEdgeType AddEdge(vtkIdType u, vtkIdType v);

  vtkEdgeType AddEdge(vtkIdType u, vtkIdType v,
                      vtkVariantArray *propertyArr);

  vtkEdgeType AddEdge(const vtkVariant& u, vtkIdType v,
                      vtkVariantArray *propertyArr = nullptr);

  vtkEdgeType AddEdge(vtkIdType u, const vtkVariant& v,
                      vtkVariantArray *propertyArr = nullptr);

  vtkEdgeType AddEdge(const vtkVariant& u,
                      const vtkVariant& v,
                      vtkVariantArray *propertyArr = nullptr);

  void LazyAddVertex();

  void LazyAddVertex(vtkVariantArray *propertyArr);

  void LazyAddVertex(const vtkVariant& pedigreeId);

  void LazyAddEdge(vtkIdType u, vtkIdType v, vtkVariantArray *propertyArr = nullptr);

  void LazyAddEdge(const vtkVariant& u, vtkIdType v,
                   vtkVariantArray *propertyArr = nullptr);

  void LazyAddEdge(vtkIdType u, const vtkVariant& v,
                   vtkVariantArray *propertyArr = nullptr);

  void LazyAddEdge(const vtkVariant& u,
                   const vtkVariant& v,
                   vtkVariantArray *propertyArr = nullptr);

  vtkGraphEdge *AddGraphEdge(vtkIdType u, vtkIdType v);

  vtkIdType AddChild(vtkIdType parent,
                     vtkVariantArray *propertyArr);
  vtkIdType AddChild(vtkIdType parent)
    { return this->AddChild(parent, nullptr); }

  void RemoveVertex(vtkIdType v);

  void RemoveEdge(vtkIdType e);

  void RemoveVertices(vtkIdTypeArray* arr);

  void RemoveEdges(vtkIdTypeArray* arr);

protected:
  vtkMutableDirectedGraph();
  ~vtkMutableDirectedGraph() override;

  vtkGraphEdge *GraphEdge;

private:
  vtkMutableDirectedGraph(const vtkMutableDirectedGraph&) = delete;
  void operator=(const vtkMutableDirectedGraph&) = delete;
};

#endif