VTK  9.1.20211024
vtkInEdgeIterator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkInEdgeIterator.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 vtkInEdgeIterator_h
55 #define vtkInEdgeIterator_h
56 
57 #include "vtkCommonDataModelModule.h" // For export macro
58 #include "vtkObject.h"
59 
60 #include "vtkGraph.h" // For edge type definitions
61 
62 class vtkGraphEdge;
63 
64 class VTKCOMMONDATAMODEL_EXPORT vtkInEdgeIterator : public vtkObject
65 {
66 public:
68  vtkTypeMacro(vtkInEdgeIterator, vtkObject);
69  void PrintSelf(ostream& os, vtkIndent indent) override;
70 
75 
77 
80  vtkGetObjectMacro(Graph, vtkGraph);
81  vtkGetMacro(Vertex, vtkIdType);
83 
85 
89  {
90  vtkInEdgeType e = *this->Current;
91  ++this->Current;
92  return e;
93  }
95 
104 
108  bool HasNext() { return this->Current != this->End; }
109 
110 protected:
112  ~vtkInEdgeIterator() override;
113 
118  virtual void SetGraph(vtkGraph* graph);
119 
125 
126 private:
127  vtkInEdgeIterator(const vtkInEdgeIterator&) = delete;
128  void operator=(const vtkInEdgeIterator&) = 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
Iterates through all incoming edges to a vertex.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
virtual void SetGraph(vtkGraph *graph)
Protected method for setting the graph used by Initialize().
static vtkInEdgeIterator * New()
vtkInEdgeType Next()
Returns the next edge in the graph.
void Initialize(vtkGraph *g, vtkIdType v)
Initialize the iterator with a graph and vertex.
bool HasNext()
Whether this iterator has more edges.
const vtkInEdgeType * End
vtkGraphEdge * NextGraphEdge()
Just like Next(), but returns heavy-weight vtkGraphEdge object instead of the vtkEdgeType struct,...
vtkGraphEdge * GraphEdge
~vtkInEdgeIterator() override
const vtkInEdgeType * Current
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract base class for most VTK objects
Definition: vtkObject.h:82
int vtkIdType
Definition: vtkType.h:332