VTK  9.0.20210121
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:
48  static vtkOutEdgeIterator* New();
49  vtkTypeMacro(vtkOutEdgeIterator, vtkObject);
50  void PrintSelf(ostream& os, vtkIndent indent) override;
51 
55  void Initialize(vtkGraph* g, vtkIdType v);
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 
84  vtkGraphEdge* NextGraphEdge();
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
vtkOutEdgeIterator::Next
vtkOutEdgeType Next()
Returns the next edge in the graph.
Definition: vtkOutEdgeIterator.h:69
vtkIdType
int vtkIdType
Definition: vtkType.h:330
vtkObject::New
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:62
vtkOutEdgeIterator::Vertex
vtkIdType Vertex
Definition: vtkOutEdgeIterator.h:104
vtkOutEdgeIterator::Current
const vtkOutEdgeType * Current
Definition: vtkOutEdgeIterator.h:102
vtkOutEdgeIterator::GraphEdge
vtkGraphEdge * GraphEdge
Definition: vtkOutEdgeIterator.h:105
vtkOutEdgeIterator::End
const vtkOutEdgeType * End
Definition: vtkOutEdgeIterator.h:103
vtkGraphEdge
Representation of a single graph edge.
Definition: vtkGraphEdge.h:39
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkOutEdgeIterator::HasNext
bool HasNext()
Whether this iterator has more edges.
Definition: vtkOutEdgeIterator.h:89
vtkOutEdgeIterator
Iterates through all outgoing edges from a vertex.
Definition: vtkOutEdgeIterator.h:45
vtkObject::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkGraph.h
vtkObject.h
vtkOutEdgeType
Definition: vtkGraph.h:254
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:289
vtkOutEdgeIterator::Graph
vtkGraph * Graph
Definition: vtkOutEdgeIterator.h:101