vtkCollapseVerticesByArray Class Reference

#include <vtkCollapseVerticesByArray.h>

Inheritance diagram for vtkCollapseVerticesByArray:

[legend]

Collaboration diagram for vtkCollapseVerticesByArray:

[legend]

List of all members.

Detailed Description

Collapse the graph given a vertex array.

vtkCollapseVerticesByArray is a class which collapses the graph using a vertex array as the key. So if the graph has vertices sharing common traits then this class combines all these vertices into one. This class does not perform aggregation on vertex data but allow to do so for edge data. Users can choose one or more edge data arrays for aggregation using AddAggregateEdgeArray function.

Tests:: vtkCollapseVerticesByArray (Tests)

Definition at line 39 of file vtkCollapseVerticesByArray.h.


Public Types
typedef vtkGraphAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	AddAggregateEdgeArray (const char *arrName)
void	ClearAggregateEdgeArray ()

virtual bool	GetAllowSelfLoops ()
virtual void	SetAllowSelfLoops (bool)
virtual void	AllowSelfLoopsOn ()
virtual void	AllowSelfLoopsOff ()

virtual char *	GetVertexArray ()
virtual void	SetVertexArray (const char *)

virtual bool	GetCountEdgesCollapsed ()
virtual void	SetCountEdgesCollapsed (bool)
virtual void	CountEdgesCollapsedOn ()
virtual void	CountEdgesCollapsedOff ()

virtual char *	GetEdgesCollapsedArray ()
virtual void	SetEdgesCollapsedArray (const char *)

virtual bool	GetCountVerticesCollapsed ()
virtual void	SetCountVerticesCollapsed (bool)
virtual void	CountVerticesCollapsedOn ()
virtual void	CountVerticesCollapsedOff ()

virtual char *	GetVerticesCollapsedArray ()
virtual void	SetVerticesCollapsedArray (const char *)
Static Public Member Functions
static vtkCollapseVerticesByArray *	New ()
static int	IsTypeOf (const char *type)
static vtkCollapseVerticesByArray *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkCollapseVerticesByArray ()
	~vtkCollapseVerticesByArray ()
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
vtkGraph *	Create (vtkGraph *inGraph)

virtual int	RequestData (vtkInformation request, vtkInformationVector inputVector, vtkInformationVector outputVector)

void	FindEdge (vtkGraph *outGraph, vtkIdType source, vtkIdType target, vtkIdType &edgeId)
Protected Attributes
bool	AllowSelfLoops
char *	VertexArray
bool	CountEdgesCollapsed
char *	EdgesCollapsedArray
bool	CountVerticesCollapsed
char *	VerticesCollapsedArray
vtkCollapseVerticesByArrayInternal *	Internal

Member Typedef Documentation

typedef vtkGraphAlgorithm vtkCollapseVerticesByArray::Superclass

Reimplemented from vtkGraphAlgorithm.

Definition at line 43 of file vtkCollapseVerticesByArray.h.

Constructor & Destructor Documentation

vtkCollapseVerticesByArray::vtkCollapseVerticesByArray ( ) [protected]

vtkCollapseVerticesByArray::~vtkCollapseVerticesByArray ( ) [protected]

Member Function Documentation

static vtkCollapseVerticesByArray* vtkCollapseVerticesByArray::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkGraphAlgorithm.

virtual const char* vtkCollapseVerticesByArray::GetClassName ( ) [virtual]

Reimplemented from vtkGraphAlgorithm.

static int vtkCollapseVerticesByArray::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGraphAlgorithm.

virtual int vtkCollapseVerticesByArray::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkGraphAlgorithm.

static vtkCollapseVerticesByArray* vtkCollapseVerticesByArray::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkGraphAlgorithm.

void vtkCollapseVerticesByArray::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)			`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkGraphAlgorithm.

virtual bool vtkCollapseVerticesByArray::GetAllowSelfLoops ( ) [virtual]

Boolean to allow self loops during collapse.

virtual void vtkCollapseVerticesByArray::SetAllowSelfLoops ( bool ) [virtual]

Boolean to allow self loops during collapse.

virtual void vtkCollapseVerticesByArray::AllowSelfLoopsOn ( ) [virtual]

Boolean to allow self loops during collapse.

virtual void vtkCollapseVerticesByArray::AllowSelfLoopsOff ( ) [virtual]

Boolean to allow self loops during collapse.

void vtkCollapseVerticesByArray::AddAggregateEdgeArray ( const char * arrName )

Add arrays on which aggregation of data is allowed. Default if replaced by the last value.

void vtkCollapseVerticesByArray::ClearAggregateEdgeArray ( )

Clear the list of arrays on which aggregation was set to allow.

virtual char* vtkCollapseVerticesByArray::GetVertexArray ( ) [virtual]

Set the array using which perform the collapse.

virtual void vtkCollapseVerticesByArray::SetVertexArray ( const char * ) [virtual]

Set the array using which perform the collapse.

virtual bool vtkCollapseVerticesByArray::GetCountEdgesCollapsed ( ) [virtual]

Set if count should be made of how many edges collapsed.

virtual void vtkCollapseVerticesByArray::SetCountEdgesCollapsed ( bool ) [virtual]

Set if count should be made of how many edges collapsed.

virtual void vtkCollapseVerticesByArray::CountEdgesCollapsedOn ( ) [virtual]

Set if count should be made of how many edges collapsed.

virtual void vtkCollapseVerticesByArray::CountEdgesCollapsedOff ( ) [virtual]

Set if count should be made of how many edges collapsed.

virtual char* vtkCollapseVerticesByArray::GetEdgesCollapsedArray ( ) [virtual]

Name of the array where the count of how many edges collapsed will be stored.By default the name of array is "EdgesCollapsedCountArray".

virtual void vtkCollapseVerticesByArray::SetEdgesCollapsedArray ( const char * ) [virtual]

Name of the array where the count of how many edges collapsed will be stored.By default the name of array is "EdgesCollapsedCountArray".

virtual bool vtkCollapseVerticesByArray::GetCountVerticesCollapsed ( ) [virtual]

Get/Set if count should be made of how many vertices collapsed.

virtual void vtkCollapseVerticesByArray::SetCountVerticesCollapsed ( bool ) [virtual]

Get/Set if count should be made of how many vertices collapsed.

virtual void vtkCollapseVerticesByArray::CountVerticesCollapsedOn ( ) [virtual]

Get/Set if count should be made of how many vertices collapsed.

virtual void vtkCollapseVerticesByArray::CountVerticesCollapsedOff ( ) [virtual]

Get/Set if count should be made of how many vertices collapsed.

virtual char* vtkCollapseVerticesByArray::GetVerticesCollapsedArray ( ) [virtual]

Name of the array where the count of how many vertices collapsed will be stored. By default name of the array is "VerticesCollapsedCountArray".

virtual void vtkCollapseVerticesByArray::SetVerticesCollapsedArray ( const char * ) [virtual]

Name of the array where the count of how many vertices collapsed will be stored. By default name of the array is "VerticesCollapsedCountArray".

virtual int vtkCollapseVerticesByArray::RequestData	(	vtkInformation *	request,
		vtkInformationVector **	inputVector,
		vtkInformationVector *	outputVector
	)			`[protected, virtual]`