VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkSplitColumnComponents Class Reference

split multicomponent table columns More...

#include <vtkSplitColumnComponents.h>

Inheritance diagram for vtkSplitColumnComponents:
Inheritance graph
[legend]
Collaboration diagram for vtkSplitColumnComponents:
Collaboration graph
[legend]

List of all members.

Public Types

enum  { NUMBERS_WITH_PARENS = 0, NAMES_WITH_PARENS = 1, NUMBERS_WITH_UNDERSCORES = 2, NAMES_WITH_UNDERSCORES = 3 }
typedef vtkTableAlgorithm Superclass

Public Member Functions

virtual int IsA (const char *type)
vtkSplitColumnComponentsNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetCalculateMagnitudes (bool)
virtual bool GetCalculateMagnitudes ()
virtual void SetNamingMode (int)
void SetNamingModeToNumberWithParens ()
void SetNamingModeToNumberWithUnderscores ()
void SetNamingModeToNamesWithParens ()
void SetNamingModeToNamesWithUnderscores ()
virtual int GetNamingMode ()

Static Public Member Functions

static vtkSplitColumnComponentsNew ()
static int IsTypeOf (const char *type)
static vtkSplitColumnComponentsSafeDownCast (vtkObjectBase *o)

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 vtkSplitColumnComponents ()
 ~vtkSplitColumnComponents ()
vtkStdString GetComponentLabel (vtkAbstractArray *array, int component_no)
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

bool CalculateMagnitudes
int NamingMode

Detailed Description

split multicomponent table columns

Splits any columns in a table that have more than one component into individual columns. Single component columns are passed through without any data duplication. NamingMode can be used to control how columns with multiple components are labelled in the output, e.g., if column names "Points" had three components this column would be split into "Points (0)", "Points (1)", and Points (2)" when NamingMode is NUMBERS_WITH_PARENS, into Points_0, Points_1, and Points_2 when NamingMode is NUMBERS_WITH_UNDERSCORES, into "Points (X)", "Points (Y)", and "Points (Z)" when NamingMode is NAMES_WITH_PARENS, and into Points_X, Points_Y, and Points_Z when NamingMode is NAMES_WITH_UNDERSCORES.

Tests:
vtkSplitColumnComponents (Tests)

Definition at line 46 of file vtkSplitColumnComponents.h.


Member Typedef Documentation

Reimplemented from vtkTableAlgorithm.

Definition at line 50 of file vtkSplitColumnComponents.h.


Member Enumeration Documentation

anonymous enum
Enumerator:
NUMBERS_WITH_PARENS 
NAMES_WITH_PARENS 
NUMBERS_WITH_UNDERSCORES 
NAMES_WITH_UNDERSCORES 

Definition at line 60 of file vtkSplitColumnComponents.h.


Constructor & Destructor Documentation


Member Function Documentation

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

Reimplemented from vtkTableAlgorithm.

static int vtkSplitColumnComponents::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 vtkTableAlgorithm.

virtual int vtkSplitColumnComponents::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 vtkTableAlgorithm.

Reimplemented from vtkTableAlgorithm.

virtual vtkObjectBase* vtkSplitColumnComponents::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkTableAlgorithm.

Reimplemented from vtkTableAlgorithm.

void vtkSplitColumnComponents::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 vtkTableAlgorithm.

virtual void vtkSplitColumnComponents::SetCalculateMagnitudes ( bool  ) [virtual]

If on this filter will calculate an additional magnitude column for all columns it splits with two or more components. Default is on.

If on this filter will calculate an additional magnitude column for all columns it splits with two or more components. Default is on.

virtual void vtkSplitColumnComponents::SetNamingMode ( int  ) [virtual]

Get/Set the array naming mode. Description is NUMBERS_WITH_PARENS.

Get/Set the array naming mode. Description is NUMBERS_WITH_PARENS.

Definition at line 71 of file vtkSplitColumnComponents.h.

Get/Set the array naming mode. Description is NUMBERS_WITH_PARENS.

Definition at line 73 of file vtkSplitColumnComponents.h.

Get/Set the array naming mode. Description is NUMBERS_WITH_PARENS.

Definition at line 75 of file vtkSplitColumnComponents.h.

Get/Set the array naming mode. Description is NUMBERS_WITH_PARENS.

Definition at line 77 of file vtkSplitColumnComponents.h.

Get/Set the array naming mode. Description is NUMBERS_WITH_PARENS.

Returns the label to use for the specific component in the array based on this->NamingMode. Use component_no==-1 for magnitude.

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

This is called by the superclass. This is the method you should override.

Reimplemented from vtkTableAlgorithm.


Member Data Documentation

Definition at line 90 of file vtkSplitColumnComponents.h.

Definition at line 97 of file vtkSplitColumnComponents.h.


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