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 -------------------------------------------------------------------------*/
35 #ifndef vtkInEdgeIterator_h
36 #define vtkInEdgeIterator_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 vtkInEdgeIterator : public vtkObject
46 {
47 public:
48  static vtkInEdgeIterator *New();
49  vtkTypeMacro(vtkInEdgeIterator, 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  vtkInEdgeType e = *this->Current;
72  ++this->Current;
73  return e;
74  }
76 
84  vtkGraphEdge *NextGraphEdge();
85 
89  bool HasNext()
90  {
91  return this->Current != this->End;
92  }
93 
94 protected:
96  ~vtkInEdgeIterator() override;
97 
102  virtual void SetGraph(vtkGraph *graph);
103 
109 
110 private:
111  vtkInEdgeIterator(const vtkInEdgeIterator&) = delete;
112  void operator=(const vtkInEdgeIterator&) = delete;
113 };
114 
115 #endif
vtkInEdgeType Next()
Returns the next edge in the graph.
abstract base class for most VTK objects
Definition: vtkObject.h:53
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:345
vtkGraphEdge * GraphEdge
Base class for graph data types.
Definition: vtkGraph.h:281
a simple class to control print indentation
Definition: vtkIndent.h:33
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