VTK
vtkVertexListIterator.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkVertexListIterator.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 -------------------------------------------------------------------------*/
37 #ifndef vtkVertexListIterator_h
38 #define vtkVertexListIterator_h
39 
40 #include "vtkCommonDataModelModule.h" // For export macro
41 #include "vtkObject.h"
42 
43 #include "vtkGraph.h" // For edge type definitions
44 
45 class vtkGraphEdge;
46 
47 class VTKCOMMONDATAMODEL_EXPORT vtkVertexListIterator : public vtkObject
48 {
49 public:
52  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
53 
57  virtual void SetGraph(vtkGraph *graph);
58 
60 
63  vtkGetObjectMacro(Graph, vtkGraph);
65 
67 
71  {
72  vtkIdType v = this->Current;
73  ++this->Current;
74  return v;
75  }
77 
81  bool HasNext()
82  {
83  return this->Current != this->End;
84  }
85 
86 protected:
88  ~vtkVertexListIterator() VTK_OVERRIDE;
89 
90  vtkGraph *Graph;
91  vtkIdType Current;
92  vtkIdType End;
93 
94 private:
95  vtkVertexListIterator(const vtkVertexListIterator&) VTK_DELETE_FUNCTION;
96  void operator=(const vtkVertexListIterator&) VTK_DELETE_FUNCTION;
97 };
98 
99 #endif
vtkIdType
int vtkIdType
Definition: vtkType.h:287
vtkVertexListIterator::HasNext
bool HasNext()
Whether this iterator has more edges.
Definition: vtkVertexListIterator.h:81
vtkVertexListIterator::Next
vtkIdType Next()
Returns the next edge in the graph.
Definition: vtkVertexListIterator.h:70
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
vtkVertexListIterator::vtkVertexListIterator
vtkVertexListIterator()
vtkGraphEdge
Representation of a single graph edge.
Definition: vtkGraphEdge.h:40
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkVertexListIterator::New
static vtkVertexListIterator * New()
vtkGraph.h
vtkObject.h
vtkVertexListIterator::~vtkVertexListIterator
~vtkVertexListIterator() override
vtkVertexListIterator
Iterates all vertices in a graph.
Definition: vtkVertexListIterator.h:48
vtkGraph
Base class for graph data types.
Definition: vtkGraph.h:288
vtkVertexListIterator::SetGraph
virtual void SetGraph(vtkGraph *graph)
Setup the iterator with a graph.
vtkVertexListIterator::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.