VTK
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 -------------------------------------------------------------------------*/
38 #ifndef vtkInEdgeIterator_h
39 #define vtkInEdgeIterator_h
40 
41 #include "vtkCommonDataModelModule.h" // For export macro
42 #include "vtkObject.h"
43 
44 #include "vtkGraph.h" // For edge type definitions
45 
46 class vtkGraphEdge;
47 
48 class VTKCOMMONDATAMODEL_EXPORT vtkInEdgeIterator : public vtkObject
49 {
50 public:
51  static vtkInEdgeIterator *New();
52  vtkTypeMacro(vtkInEdgeIterator, vtkObject);
53  void PrintSelf(ostream& os, vtkIndent indent) override;
54 
58  void Initialize(vtkGraph *g, vtkIdType v);
59 
61 
64  vtkGetObjectMacro(Graph, vtkGraph);
65  vtkGetMacro(Vertex, vtkIdType);
67 
69 
73  {
74  vtkInEdgeType e = *this->Current;
75  ++this->Current;
76  return e;
77  }
79 
87  vtkGraphEdge *NextGraphEdge();
88 
92  bool HasNext()
93  {
94  return this->Current != this->End;
95  }
96 
97 protected:
99  ~vtkInEdgeIterator() override;
100 
105  virtual void SetGraph(vtkGraph *graph);
106 
112 
113 private:
114  vtkInEdgeIterator(const vtkInEdgeIterator&) = delete;
115  void operator=(const vtkInEdgeIterator&) = delete;
116 };
117 
118 #endif
vtkInEdgeType Next()
Returns the next edge in the graph.
abstract base class for most VTK objects
Definition: vtkObject.h:59
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
Representation of a single graph edge.
Definition: vtkGraphEdge.h:39
bool HasNext()
Whether this iterator has more edges.
int vtkIdType
Definition: vtkType.h:347
vtkGraphEdge * GraphEdge
Base class for graph data types.
Definition: vtkGraph.h:287
a simple class to control print indentation
Definition: vtkIndent.h:39
Iterates through all incoming edges to a vertex.
const vtkInEdgeType * End
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
const vtkInEdgeType * Current