VTK  9.3.20240423
vtkOutEdgeIterator.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-FileCopyrightText: Copyright 2008 Sandia Corporation
3// SPDX-License-Identifier: LicenseRef-BSD-3-Clause-Sandia-USGov
44#ifndef vtkOutEdgeIterator_h
45#define vtkOutEdgeIterator_h
46
47#include "vtkCommonDataModelModule.h" // For export macro
48#include "vtkObject.h"
49
50#include "vtkGraph.h" // For edge type definitions
51
52VTK_ABI_NAMESPACE_BEGIN
53class vtkGraphEdge;
54
55class VTKCOMMONDATAMODEL_EXPORT vtkOutEdgeIterator : public vtkObject
56{
57public:
60 void PrintSelf(ostream& os, vtkIndent indent) override;
61
66
68
71 vtkGetObjectMacro(Graph, vtkGraph);
72 vtkGetMacro(Vertex, vtkIdType);
74
76
80 {
81 vtkOutEdgeType e = *this->Current;
82 ++this->Current;
83 return e;
84 }
86
95
99 bool HasNext() { return this->Current != this->End; }
100
101protected:
104
109 virtual void SetGraph(vtkGraph* graph);
110
116
117private:
118 vtkOutEdgeIterator(const vtkOutEdgeIterator&) = delete;
119 void operator=(const vtkOutEdgeIterator&) = delete;
120};
121
122VTK_ABI_NAMESPACE_END
123#endif
Representation of a single graph edge.
Base class for graph data types.
Definition vtkGraph.h:340
a simple class to control print indentation
Definition vtkIndent.h:108
abstract base class for most VTK objects
Definition vtkObject.h:162
Iterates through all outgoing edges from a vertex.
const vtkOutEdgeType * End
static vtkOutEdgeIterator * New()
virtual void SetGraph(vtkGraph *graph)
Protected method for setting the graph used by Initialize().
const vtkOutEdgeType * Current
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkGraphEdge * NextGraphEdge()
Just like Next(), but returns heavy-weight vtkGraphEdge object instead of the vtkEdgeType struct,...
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.
int vtkIdType
Definition vtkType.h:315