VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkGraphWeightFilter Class Referenceabstract

Base class for filters that weight graph edges. More...

#include <vtkGraphWeightFilter.h>

Inheritance diagram for vtkGraphWeightFilter:
[legend]

Public Types

typedef vtkGraphAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkGraphWeightFilterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkGraphWeightFilterSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkGraphWeightFilter ()
 
 ~vtkGraphWeightFilter ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual float ComputeWeight (vtkGraph *const graph, const vtkEdgeType &edge) const =0
 
virtual bool CheckRequirements (vtkGraph *const graph) const
 

Detailed Description

Base class for filters that weight graph edges.

vtkGraphWeightFilter is the abstract base class that provides an interface for classes that apply weights to graph edges. The weights are added as a vtkFloatArray named "Weights." The ComputeWeight function must be implemented to provide the function of two vertices which determines the weight of each edge. The CheckRequirements function can be implemented if you wish to ensure that the input graph has all of the properties that will be required by the ComputeWeight function.

Definition at line 38 of file vtkGraphWeightFilter.h.

Member Typedef Documentation

typedef vtkGraphAlgorithm vtkGraphWeightFilter::Superclass

Definition at line 41 of file vtkGraphWeightFilter.h.

Constructor & Destructor Documentation

vtkGraphWeightFilter::vtkGraphWeightFilter ( )
inlineprotected

Definition at line 45 of file vtkGraphWeightFilter.h.

vtkGraphWeightFilter::~vtkGraphWeightFilter ( )
inlineprotected

Definition at line 46 of file vtkGraphWeightFilter.h.

Member Function Documentation

static int vtkGraphWeightFilter::IsTypeOf ( const char *  type)
static
virtual int vtkGraphWeightFilter::IsA ( const char *  type)
virtual
static vtkGraphWeightFilter* vtkGraphWeightFilter::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkGraphWeightFilter::NewInstanceInternal ( ) const
protectedvirtual
vtkGraphWeightFilter* vtkGraphWeightFilter::NewInstance ( ) const
void vtkGraphWeightFilter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
int vtkGraphWeightFilter::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected
virtual float vtkGraphWeightFilter::ComputeWeight ( vtkGraph *const  graph,
const vtkEdgeType &  edge 
) const
protectedpure virtual

Compute the weight on the 'graph' for a particular 'edge'. This is a pure virtual function that must be implemented in subclasses.

Implemented in vtkGraphWeightEuclideanDistanceFilter.

virtual bool vtkGraphWeightFilter::CheckRequirements ( vtkGraph *const  graph) const
protectedvirtual

Ensure that the 'graph' is has all properties that are needed to compute the weights. For example, in vtkGraphWeightEuclideanDistanceFilter, 'graph' must have Points set for each vertex, as the ComputeWeight function calls GetPoint.

Reimplemented in vtkGraphWeightEuclideanDistanceFilter.


The documentation for this class was generated from the following file: