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
46class vtkGraphEdge;
47
48class VTKCOMMONDATAMODEL_EXPORT vtkInEdgeIterator : public vtkObject
49{
50public:
53 void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
54
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
88
92 bool HasNext()
93 {
94 return this->Current != this->End;
95 }
96
97protected:
99 ~vtkInEdgeIterator() VTK_OVERRIDE;
100
105 virtual void SetGraph(vtkGraph *graph);
106
107 vtkGraph *Graph;
108 const vtkInEdgeType *Current;
109 const vtkInEdgeType *End;
110 vtkIdType Vertex;
111 vtkGraphEdge *GraphEdge;
112
113private:
114 vtkInEdgeIterator(const vtkInEdgeIterator&) VTK_DELETE_FUNCTION;
115 void operator=(const vtkInEdgeIterator&) VTK_DELETE_FUNCTION;
116};
117
118#endif
Representation of a single graph edge.
Definition: vtkGraphEdge.h:40
Base class for graph data types.
Definition: vtkGraph.h:288
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.
vtkInEdgeType Next()
Returns the next edge in the graph.
void Initialize(vtkGraph *g, vtkIdType v)
Initialize the iterator with a graph and vertex.
static vtkInEdgeIterator * New()
bool HasNext()
Whether this iterator has more edges.
vtkGraphEdge * NextGraphEdge()
Just like Next(), but returns heavy-weight vtkGraphEdge object instead of the vtkEdgeType struct,...
~vtkInEdgeIterator() override
a simple class to control print indentation
Definition: vtkIndent.h:40
abstract base class for most VTK objects
Definition: vtkObject.h:60
int vtkIdType
Definition: vtkType.h:287