vtkChacoReader Class Reference

#include <vtkChacoReader.h>

Inheritance diagram for vtkChacoReader:

[legend]Collaboration diagram for vtkChacoReader:

[legend]List of all members.

---

Detailed Description

Read a Chaco file and create a vtkUnstructuredGrid.

vtkChacoReader is an unstructured grid source object that reads Chaco files. The reader DOES NOT respond to piece requests. Chaco is a graph partitioning package developed at Sandia National Laboratories in the early 1990s. (http://www.cs.sandia.gov/~bahendr/chaco.html)

Note that the Chaco "edges" become VTK "cells", and the Chaco "vertices" become VTK "points".

Tests:

vtkChacoReader (Tests)

Definition at line 40 of file vtkChacoReader.h.

Public Types
typedef vtkUnstructuredGridAlgorithm	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	SetBaseName (const char *)
virtual char *	GetBaseName ()
virtual void	SetGenerateGlobalElementIdArray (int)
virtual int	GetGenerateGlobalElementIdArray ()
virtual void	GenerateGlobalElementIdArrayOn ()
virtual void	GenerateGlobalElementIdArrayOff ()
virtual void	SetGenerateGlobalNodeIdArray (int)
virtual int	GetGenerateGlobalNodeIdArray ()
virtual void	GenerateGlobalNodeIdArrayOn ()
virtual void	GenerateGlobalNodeIdArrayOff ()
virtual void	SetGenerateVertexWeightArrays (int)
virtual int	GetGenerateVertexWeightArrays ()
virtual void	GenerateVertexWeightArraysOn ()
virtual void	GenerateVertexWeightArraysOff ()
virtual int	GetNumberOfVertexWeights ()
char *	GetVertexWeightArrayName (int weight)
virtual void	SetGenerateEdgeWeightArrays (int)
virtual int	GetGenerateEdgeWeightArrays ()
virtual void	GenerateEdgeWeightArraysOn ()
virtual void	GenerateEdgeWeightArraysOff ()
virtual int	GetNumberOfEdgeWeights ()
virtual int	GetNumberOfCellWeightArrays ()
virtual int	GetNumberOfPointWeightArrays ()
char *	GetEdgeWeightArrayName (int weight)
virtual int	GetDimensionality ()
virtual vtkIdType	GetNumberOfEdges ()
virtual vtkIdType	GetNumberOfVertices ()
Static Public Member Functions
static vtkChacoReader *	New ()
static int	IsTypeOf (const char *type)
static vtkChacoReader *	SafeDownCast (vtkObject *o)
static const char *	GetGlobalElementIdArrayName ()
static const char *	GetGlobalNodeIdArrayName ()
Protected Member Functions
	vtkChacoReader ()
	~vtkChacoReader ()
int	BuildOutputGrid (vtkUnstructuredGrid *gr)
void	CloseCurrentFile ()
int	OpenCurrentFile ()
int	InputGeom (vtkIdType nvtxs, int igeom, double *x, double *y, double *z)
int	InputGraph1 ()
int	InputGraph2 (vtkIdType **start, vtkIdType **adjacency, double **vweights, double **eweights)
int	GetCoordsMetadata ()
void	GetGraphMetadata ()
int	ReadFile (vtkUnstructuredGrid *output)
void	AddElementIds (vtkUnstructuredGrid *output)
void	AddNodeIds (vtkUnstructuredGrid *output)
void	MakeWeightArrayNames (int nv, int ne)
virtual void	SetCurrentBaseName (const char *)
int	RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Attributes
char *	BaseName
int	GenerateGlobalElementIdArray
int	GenerateGlobalNodeIdArray
int	GenerateVertexWeightArrays
int	GenerateEdgeWeightArrays
FILE *	CurrentGeometryFP
FILE *	CurrentGraphFP
char *	CurrentBaseName
char **	VarrayName
char **	EarrayName
int	Dimensionality
vtkIdType	NumberOfVertices
vtkIdType	NumberOfEdges
int	NumberOfVertexWeights
int	NumberOfEdgeWeights
int	GraphFileHasVertexNumbers
int	NumberOfPointWeightArrays
int	NumberOfCellWeightArrays
vtkUnstructuredGrid *	DataCache
int	RemakeDataCacheFlag

---

Member Typedef Documentation

typedef vtkUnstructuredGridAlgorithm vtkChacoReader::Superclass

Reimplemented from vtkUnstructuredGridAlgorithm. Reimplemented in vtkPChacoReader. Definition at line 44 of file vtkChacoReader.h.

---

Constructor & Destructor Documentation

vtkChacoReader::vtkChacoReader (   )  [protected]

vtkChacoReader::~vtkChacoReader (   )  [protected]

---

Member Function Documentation

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

Create an object with Debug turned off, modified time initialized to zero, and reference counting on. Reimplemented from vtkUnstructuredGridAlgorithm. Reimplemented in vtkPChacoReader.

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

Reimplemented from vtkUnstructuredGridAlgorithm. Reimplemented in vtkPChacoReader.

static int vtkChacoReader::IsTypeOf (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkUnstructuredGridAlgorithm. Reimplemented in vtkPChacoReader.

virtual int vtkChacoReader::IsA (  const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h. Reimplemented from vtkUnstructuredGridAlgorithm. Reimplemented in vtkPChacoReader.

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

Reimplemented from vtkUnstructuredGridAlgorithm. Reimplemented in vtkPChacoReader.

void vtkChacoReader::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 vtkUnstructuredGridAlgorithm. Reimplemented in vtkPChacoReader.

virtual void vtkChacoReader::SetBaseName (  const char *   )  [virtual]

Specify the base name of the Chaco files. The reader will try to open BaseName.coords and BaseName.graph.

virtual char* vtkChacoReader::GetBaseName (   )  [virtual]

virtual void vtkChacoReader::SetGenerateGlobalElementIdArray (  int   )  [virtual]

Indicate whether this reader should create a cell array containing global IDs for the cells in the output vtkUnstructuredGrid. These cells represent the edges that were in the Chaco file. Each edge is a vtkLine. Default is ON.

virtual int vtkChacoReader::GetGenerateGlobalElementIdArray (   )  [virtual]

virtual void vtkChacoReader::GenerateGlobalElementIdArrayOn (   )  [virtual]

virtual void vtkChacoReader::GenerateGlobalElementIdArrayOff (   )  [virtual]

static const char* vtkChacoReader::GetGlobalElementIdArrayName (   )  [inline, static]

Definition at line 62 of file vtkChacoReader.h.

virtual void vtkChacoReader::SetGenerateGlobalNodeIdArray (  int   )  [virtual]

Indicate whether this reader should create a point array of global IDs for the points in the output vtkUnstructuredGrid. These points are the vertices that were in the Chaco file. Global point IDs start at "1" for the first vertex in BaseName.coords and go up from there. Default is ON.

virtual int vtkChacoReader::GetGenerateGlobalNodeIdArray (   )  [virtual]

virtual void vtkChacoReader::GenerateGlobalNodeIdArrayOn (   )  [virtual]

virtual void vtkChacoReader::GenerateGlobalNodeIdArrayOff (   )  [virtual]

static const char* vtkChacoReader::GetGlobalNodeIdArrayName (   )  [inline, static]

Definition at line 74 of file vtkChacoReader.h.

virtual void vtkChacoReader::SetGenerateVertexWeightArrays (  int   )  [virtual]

Indicate whether this reader should create a point array for each vertex weight in the Chaco file. Default is OFF.

virtual int vtkChacoReader::GetGenerateVertexWeightArrays (   )  [virtual]

virtual void vtkChacoReader::GenerateVertexWeightArraysOn (   )  [virtual]

virtual void vtkChacoReader::GenerateVertexWeightArraysOff (   )  [virtual]

virtual int vtkChacoReader::GetNumberOfVertexWeights (   )  [virtual]

Returns the number of weights per vertex in the Chaco file, whether or not GenerateVertexWeightArrays is ON.

char* vtkChacoReader::GetVertexWeightArrayName (  int  weight  )

This method returns the name of the selected Vertex weight point array. If you did not turn on GenerateVertexWeightArrays, or if the weight you requested is invalid, it returns NULL. Weights begin at one and go up to NumberOfVertexWeights. This is a pointer to our copy of the name, so don't "delete" it.

virtual void vtkChacoReader::SetGenerateEdgeWeightArrays (  int   )  [virtual]

Each edge in the Chaco file connects two vertices. The file may specify one or more weights for each edge. (The weight for an edge from vertex A to vertex B equals the weight from B to A.) Indicate with the following parameter whether this reader should create a cell array for each weight for every edge. Default is OFF.

virtual int vtkChacoReader::GetGenerateEdgeWeightArrays (   )  [virtual]

virtual void vtkChacoReader::GenerateEdgeWeightArraysOn (   )  [virtual]

virtual void vtkChacoReader::GenerateEdgeWeightArraysOff (   )  [virtual]

virtual int vtkChacoReader::GetNumberOfEdgeWeights (   )  [virtual]

Returns the number of weights per edge in the Chaco file, whether or not GenerateEdgeWeightArrays is ON.

char* vtkChacoReader::GetEdgeWeightArrayName (  int  weight  )

This method returns the name of the selected Edge weight cell array. If you did not turn on GenerateEdgeWeightArrays, or if the weight you requested is invalid, it returns NULL. Weights begin at one and go up to NumberOfEdgeWeights. This is a pointer to our copy of the name, so don't "delete" it.

virtual int vtkChacoReader::GetDimensionality (   )  [virtual]

Access to meta data generated by RequestInformation.

virtual vtkIdType vtkChacoReader::GetNumberOfEdges (   )  [virtual]

This method returns the name of the selected Edge weight cell array. If you did not turn on GenerateEdgeWeightArrays, or if the weight you requested is invalid, it returns NULL. Weights begin at one and go up to NumberOfEdgeWeights. This is a pointer to our copy of the name, so don't "delete" it.

virtual vtkIdType vtkChacoReader::GetNumberOfVertices (   )  [virtual]

This method returns the name of the selected Edge weight cell array. If you did not turn on GenerateEdgeWeightArrays, or if the weight you requested is invalid, it returns NULL. Weights begin at one and go up to NumberOfEdgeWeights. This is a pointer to our copy of the name, so don't "delete" it.

virtual int vtkChacoReader::GetNumberOfCellWeightArrays (   )  [virtual]

After this filter executes, this method returns the number of cell arrays that were created to hold the edge weights. It is equal to NumberOfEdgeWeights if GenerateEdgeWeightArrays was ON.

virtual int vtkChacoReader::GetNumberOfPointWeightArrays (   )  [virtual]

After this filter executes, this method returns the number of point arrays that were created to hold the vertex weights. It is equal to NumberOfVertexWeights if GenerateVertexWeightArrays was ON.

int vtkChacoReader::BuildOutputGrid (  vtkUnstructuredGrid *  gr  )  [protected]

void vtkChacoReader::CloseCurrentFile (   )  [protected]

int vtkChacoReader::OpenCurrentFile (   )  [protected]

int vtkChacoReader::InputGeom (  vtkIdType  nvtxs, int  igeom, double *  x, double *  y, double *  z )  [protected]

int vtkChacoReader::InputGraph1 (   )  [protected]

int vtkChacoReader::InputGraph2 (  vtkIdType **  start, vtkIdType **  adjacency, double **  vweights, double **  eweights )  [protected]

int vtkChacoReader::GetCoordsMetadata (   )  [protected]

void vtkChacoReader::GetGraphMetadata (   )  [protected]

int vtkChacoReader::ReadFile (  vtkUnstructuredGrid *  output  )  [protected]

void vtkChacoReader::AddElementIds (  vtkUnstructuredGrid *  output  )  [protected]

void vtkChacoReader::AddNodeIds (  vtkUnstructuredGrid *  output  )  [protected]

void vtkChacoReader::MakeWeightArrayNames (  int  nv, int  ne )  [protected]

virtual void vtkChacoReader::SetCurrentBaseName (  const char *   )  [protected, virtual]

int vtkChacoReader::RequestInformation (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [protected, virtual]

Reimplemented from vtkUnstructuredGridAlgorithm. Reimplemented in vtkPChacoReader.

int vtkChacoReader::RequestData (  vtkInformation *  , vtkInformationVector **  , vtkInformationVector *  )  [protected, virtual]

This is called by the superclass. This is the method you should override. Reimplemented from vtkUnstructuredGridAlgorithm. Reimplemented in vtkPChacoReader.

---

Member Data Documentation

char* vtkChacoReader::BaseName [protected]

Definition at line 165 of file vtkChacoReader.h.

int vtkChacoReader::GenerateGlobalElementIdArray [protected]

Definition at line 166 of file vtkChacoReader.h.

int vtkChacoReader::GenerateGlobalNodeIdArray [protected]

Definition at line 167 of file vtkChacoReader.h.

int vtkChacoReader::GenerateVertexWeightArrays [protected]

Definition at line 169 of file vtkChacoReader.h.

int vtkChacoReader::GenerateEdgeWeightArrays [protected]

Definition at line 170 of file vtkChacoReader.h.

FILE* vtkChacoReader::CurrentGeometryFP [protected]

Definition at line 172 of file vtkChacoReader.h.

FILE* vtkChacoReader::CurrentGraphFP [protected]

Definition at line 173 of file vtkChacoReader.h.

char* vtkChacoReader::CurrentBaseName [protected]

Definition at line 174 of file vtkChacoReader.h.

char** vtkChacoReader::VarrayName [protected]

Definition at line 175 of file vtkChacoReader.h.

char** vtkChacoReader::EarrayName [protected]

Definition at line 178 of file vtkChacoReader.h.

int vtkChacoReader::Dimensionality [protected]

Definition at line 185 of file vtkChacoReader.h.

vtkIdType vtkChacoReader::NumberOfVertices [protected]

Definition at line 186 of file vtkChacoReader.h.

vtkIdType vtkChacoReader::NumberOfEdges [protected]

Definition at line 187 of file vtkChacoReader.h.

int vtkChacoReader::NumberOfVertexWeights [protected]

Definition at line 188 of file vtkChacoReader.h.

int vtkChacoReader::NumberOfEdgeWeights [protected]

Definition at line 189 of file vtkChacoReader.h.

int vtkChacoReader::GraphFileHasVertexNumbers [protected]

Definition at line 190 of file vtkChacoReader.h.

int vtkChacoReader::NumberOfPointWeightArrays [protected]

Definition at line 194 of file vtkChacoReader.h.

int vtkChacoReader::NumberOfCellWeightArrays [protected]

Definition at line 195 of file vtkChacoReader.h.

vtkUnstructuredGrid* vtkChacoReader::DataCache [protected]

Definition at line 200 of file vtkChacoReader.h.

int vtkChacoReader::RemakeDataCacheFlag [protected]

Definition at line 203 of file vtkChacoReader.h.

---

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

• dox/IO/vtkChacoReader.h

---