vtkGraphEdge.h

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

  Program:   Visualization Toolkit
  Module:    vtkGraphEdge.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.
-------------------------------------------------------------------------*/
// .NAME vtkGraphEdge - Representation of a single graph edge.
//
// .SECTION Description
// A heavy-weight (vtkObject subclass) graph edge object that may be used
// instead of the vtkEdgeType struct, for use with wrappers.
// The edge contains the source and target vertex ids, and the edge id.
//
// .SECTION See Also
// vtkGraph

#ifndef __vtkGraphEdge_h
#define __vtkGraphEdge_h

#include "vtkObject.h"

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

  // Description:
  // The source of the edge.
  vtkSetMacro(Source, vtkIdType);
  vtkGetMacro(Source, vtkIdType);

  // Description:
  // The target of the edge.
  vtkSetMacro(Target, vtkIdType);
  vtkGetMacro(Target, vtkIdType);

  // Description:
  // The id of the edge.
  vtkSetMacro(Id, vtkIdType);
  vtkGetMacro(Id, vtkIdType);

protected:
  vtkGraphEdge();
  ~vtkGraphEdge();

  vtkIdType Source;
  vtkIdType Target;
  vtkIdType Id;

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

#endif