VTK  9.3.0
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
34#ifndef vtkOutEdgeIterator_h
35#define vtkOutEdgeIterator_h
36
37#include "vtkCommonDataModelModule.h" // For export macro
38#include "vtkObject.h"
39
40#include "vtkGraph.h" // For edge type definitions
41
42VTK_ABI_NAMESPACE_BEGIN
43class vtkGraphEdge;
44
45class VTKCOMMONDATAMODEL_EXPORT vtkOutEdgeIterator : public vtkObject
46{
47public:
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
91protected:
94
99 virtual void SetGraph(vtkGraph* graph);
100
106
107private:
108 vtkOutEdgeIterator(const vtkOutEdgeIterator&) = delete;
109 void operator=(const vtkOutEdgeIterator&) = delete;
110};
111
112VTK_ABI_NAMESPACE_END
113#endif
Representation of a single graph edge.
Base class for graph data types.
Definition vtkGraph.h:290
a simple class to control print indentation
Definition vtkIndent.h:38
abstract base class for most VTK objects
Definition vtkObject.h:58
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