vtkOutEdgeIterator.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkOutEdgeIterator.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
/*-------------------------------------------------------------------------
  Copyright 2008 Sandia Corporation.
  Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
  the U.S. Government retains certain rights in this software.
-------------------------------------------------------------------------*/
#ifndef vtkOutEdgeIterator_h
#define vtkOutEdgeIterator_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"

#include "vtkGraph.h" // For edge type definitions

class vtkGraphEdge;

class VTKCOMMONDATAMODEL_EXPORT vtkOutEdgeIterator : public vtkObject
{
public:
  static vtkOutEdgeIterator *New();
  vtkTypeMacro(vtkOutEdgeIterator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  void Initialize(vtkGraph *g, vtkIdType v);


  vtkGetObjectMacro(Graph, vtkGraph);
  vtkGetMacro(Vertex, vtkIdType);

  //BTX

  inline vtkOutEdgeType Next()
  {
    vtkOutEdgeType e = *this->Current;
    ++this->Current;
    return e;
  }
  //ETX

  vtkGraphEdge *NextGraphEdge();


  bool HasNext()
  {
    return this->Current != this->End;
  }

protected:
  vtkOutEdgeIterator();
  ~vtkOutEdgeIterator();

  virtual void SetGraph(vtkGraph *graph);

  vtkGraph            *Graph;
  const vtkOutEdgeType *Current;
  const vtkOutEdgeType *End;
  vtkIdType             Vertex;
  vtkGraphEdge        *GraphEdge;

private:
  vtkOutEdgeIterator(const vtkOutEdgeIterator&);  // Not implemented.
  void operator=(const vtkOutEdgeIterator&);  // Not implemented.
};

#endif