VTK  9.0.1
vtkOutEdgeIterator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkOutEdgeIterator.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 -------------------------------------------------------------------------*/
35 #ifndef vtkOutEdgeIterator_h
36 #define vtkOutEdgeIterator_h
37 
38 #include "vtkCommonDataModelModule.h" // For export macro
39 #include "vtkObject.h"
40 
41 #include "vtkGraph.h" // For edge type definitions
42 
43 class vtkGraphEdge;
44 
45 class VTKCOMMONDATAMODEL_EXPORT vtkOutEdgeIterator : public vtkObject
46 {
47 public:
49  vtkTypeMacro(vtkOutEdgeIterator, vtkObject);
50  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
56 
58 
61  vtkGetObjectMacro(Graph, vtkGraph);
62  vtkGetMacro(Vertex, vtkIdType);
64 
66 
70  {
71  vtkOutEdgeType e = *this->Current;
72  ++this->Current;
73  return e;
74  }
76 
85 
89  bool HasNext() { return this->Current != this->End; }
90 
91 protected:
93  ~vtkOutEdgeIterator() override;
94 
99  virtual void SetGraph(vtkGraph* graph);
100 
106 
107 private:
108  vtkOutEdgeIterator(const vtkOutEdgeIterator&) = delete;
109  void operator=(const vtkOutEdgeIterator&) = delete;
110 };
111 
112 #endif
Representation of a single graph edge.
Definition: vtkGraphEdge.h:40
Base class for graph data types.
Definition: vtkGraph.h:290
a simple class to control print indentation
Definition: vtkIndent.h:34
abstract base class for most VTK objects
Definition: vtkObject.h:63
Iterates through all outgoing edges from a vertex.
const vtkOutEdgeType * End
virtual void SetGraph(vtkGraph *graph)
Protected method for setting the graph used by Initialize().
vtkGraphEdge * NextGraphEdge()
Just like Next(), but returns heavy-weight vtkGraphEdge object instead of the vtkEdgeType struct,...
const vtkOutEdgeType * Current
static vtkOutEdgeIterator * New()
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
bool HasNext()
Whether this iterator has more edges.
~vtkOutEdgeIterator() override
vtkOutEdgeType Next()
Returns the next edge in the graph.
void Initialize(vtkGraph *g, vtkIdType v)
Initialize the iterator with a graph and vertex.
vtkGraphEdge * GraphEdge
int vtkIdType
Definition: vtkType.h:338