VTK  9.1.0
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-------------------------------------------------------------------------*/
54#ifndef vtkOutEdgeIterator_h
55#define vtkOutEdgeIterator_h
56
57#include "vtkCommonDataModelModule.h" // For export macro
58#include "vtkObject.h"
59
60#include "vtkGraph.h" // For edge type definitions
61
62class vtkGraphEdge;
63
64class VTKCOMMONDATAMODEL_EXPORT vtkOutEdgeIterator : public vtkObject
65{
66public:
69 void PrintSelf(ostream& os, vtkIndent indent) override;
70
75
77
80 vtkGetObjectMacro(Graph, vtkGraph);
81 vtkGetMacro(Vertex, vtkIdType);
83
85
89 {
90 vtkOutEdgeType e = *this->Current;
91 ++this->Current;
92 return e;
93 }
95
104
108 bool HasNext() { return this->Current != this->End; }
109
110protected:
113
118 virtual void SetGraph(vtkGraph* graph);
119
125
126private:
127 vtkOutEdgeIterator(const vtkOutEdgeIterator&) = delete;
128 void operator=(const vtkOutEdgeIterator&) = delete;
129};
130
131#endif
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
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.
vtkGraphEdge * GraphEdge
int vtkIdType
Definition: vtkType.h:332