vtkStringToCategory Class Reference

#include <vtkStringToCategory.h>

Inheritance diagram for vtkStringToCategory:

Inheritance graph
[legend]
Collaboration diagram for vtkStringToCategory:

Collaboration graph
[legend]

List of all members.


Detailed Description

Creates a category array from a string array.

vtkStringToCategory creates an integer array named "category" based on the values in a string array. You may use this filter to create an array that you may use to color points/cells by the values in a string array. Currently there is not support to color by a string array directly. The category values will range from zero to N-1, where N is the number of distinct strings in the string array. Set the string array to process with SetInputArrayToProcess(0,0,0,...). The array may be in the point, cell, or field data of the data object.

Tests:
vtkStringToCategory (Tests)

Definition at line 42 of file vtkStringToCategory.h.


Public Types

typedef vtkDataObjectAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetCategoryArrayName (const char *)
virtual char * GetCategoryArrayName ()
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)

Static Public Member Functions

static vtkStringToCategoryNew ()
static int IsTypeOf (const char *type)
static vtkStringToCategorySafeDownCast (vtkObject *o)

Protected Member Functions

 vtkStringToCategory ()
 ~vtkStringToCategory ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)

Protected Attributes

char * CategoryArrayName

Member Typedef Documentation

Reimplemented from vtkDataObjectAlgorithm.

Definition at line 46 of file vtkStringToCategory.h.


Constructor & Destructor Documentation

vtkStringToCategory::vtkStringToCategory (  )  [protected]

vtkStringToCategory::~vtkStringToCategory (  )  [protected]


Member Function Documentation

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

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

Reimplemented from vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.

static int vtkStringToCategory::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataObjectAlgorithm.

virtual int vtkStringToCategory::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.

void vtkStringToCategory::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 vtkDataObjectAlgorithm.

virtual void vtkStringToCategory::SetCategoryArrayName ( const char *   )  [virtual]

The name to give to the output vtkIntArray of category values.

virtual char* vtkStringToCategory::GetCategoryArrayName (  )  [virtual]

The name to give to the output vtkIntArray of category values.

virtual int vtkStringToCategory::ProcessRequest ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [virtual]

This is required to capture REQUEST_DATA_OBJECT requests.

Reimplemented from vtkDataObjectAlgorithm.

virtual int vtkStringToCategory::RequestDataObject ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

Creates the same output type as the input type.

Reimplemented from vtkDataObjectAlgorithm.

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

Reimplemented from vtkDataObjectAlgorithm.


Member Data Documentation

Definition at line 78 of file vtkStringToCategory.h.


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

Generated on Wed Jun 3 19:36:50 2009 for VTK by  doxygen 1.5.6