VTK  9.1.20211024
vtkAdjacentVertexIterator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAdjacentVertexIterator.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
15 /*-------------------------------------------------------------------------
16  Copyright 2008 Sandia Corporation.
17  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
18  the U.S. Government retains certain rights in this software.
19 -------------------------------------------------------------------------*/
53 #ifndef vtkAdjacentVertexIterator_h
54 #define vtkAdjacentVertexIterator_h
55 
56 #include "vtkCommonDataModelModule.h" // For export macro
57 #include "vtkObject.h"
58 
59 #include "vtkGraph.h" // For edge type definitions
60 
61 class vtkGraphEdge;
62 
63 class VTKCOMMONDATAMODEL_EXPORT vtkAdjacentVertexIterator : public vtkObject
64 {
65 public:
68  void PrintSelf(ostream& os, vtkIndent indent) override;
69 
74 
76 
79  vtkGetObjectMacro(Graph, vtkGraph);
80  vtkGetMacro(Vertex, vtkIdType);
82 
84 
88  {
89  vtkOutEdgeType e = *this->Current;
90  ++this->Current;
91  return e.Target;
92  }
94 
98  bool HasNext() { return this->Current != this->End; }
99 
100 protected:
103 
108  virtual void SetGraph(vtkGraph* graph);
109 
114 
115 private:
117  void operator=(const vtkAdjacentVertexIterator&) = delete;
118 };
119 
120 #endif
Iterates through adjacent vertices in a graph.
~vtkAdjacentVertexIterator() override
vtkIdType Next()
Returns the next edge in the graph.
bool HasNext()
Whether this iterator has more edges.
virtual void SetGraph(vtkGraph *graph)
Protected method for setting the graph used by Initialize().
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void Initialize(vtkGraph *g, vtkIdType v)
Initialize the iterator with a graph and vertex.
static vtkAdjacentVertexIterator * New()
Representation of a single graph edge.
Definition: vtkGraphEdge.h:40
Base class for graph data types.
Definition: vtkGraph.h:339
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract base class for most VTK objects
Definition: vtkObject.h:82
vtkIdType Target
Definition: vtkGraph.h:311
int vtkIdType
Definition: vtkType.h:332