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 | Protected Attributes | List of all members
vtkStringToNumeric Class Reference

Converts string arrays to numeric arrays. More...

#include <vtkStringToNumeric.h>

Inherits vtkDataObjectAlgorithm.

Public Types

typedef vtkDataObjectAlgorithm Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkStringToNumericNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetForceDouble (bool)
 
virtual bool GetForceDouble ()
 
virtual void ForceDoubleOn ()
 
virtual void ForceDoubleOff ()
 
virtual void SetDefaultIntegerValue (int)
 
virtual int GetDefaultIntegerValue ()
 
virtual void SetDefaultDoubleValue (double)
 
virtual double GetDefaultDoubleValue ()
 
virtual void SetTrimWhitespacePriorToNumericConversion (bool)
 
virtual bool GetTrimWhitespacePriorToNumericConversion ()
 
virtual void TrimWhitespacePriorToNumericConversionOn ()
 
virtual void TrimWhitespacePriorToNumericConversionOff ()
 
virtual void SetConvertFieldData (bool)
 
virtual bool GetConvertFieldData ()
 
virtual void ConvertFieldDataOn ()
 
virtual void ConvertFieldDataOff ()
 
virtual void SetConvertPointData (bool)
 
virtual bool GetConvertPointData ()
 
virtual void ConvertPointDataOn ()
 
virtual void ConvertPointDataOff ()
 
virtual void SetConvertCellData (bool)
 
virtual bool GetConvertCellData ()
 
virtual void ConvertCellDataOn ()
 
virtual void ConvertCellDataOff ()
 
virtual void SetConvertVertexData (bool b)
 
virtual bool GetConvertVertexData ()
 
virtual void ConvertVertexDataOn ()
 
virtual void ConvertVertexDataOff ()
 
virtual void SetConvertEdgeData (bool b)
 
virtual bool GetConvertEdgeData ()
 
virtual void ConvertEdgeDataOn ()
 
virtual void ConvertEdgeDataOff ()
 
virtual void SetConvertRowData (bool b)
 
virtual bool GetConvertRowData ()
 
virtual void ConvertRowDataOn ()
 
virtual void ConvertRowDataOff ()
 
virtual int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Static Public Member Functions

static vtkStringToNumericNew ()
 
static int IsTypeOf (const char *type)
 
static vtkStringToNumericSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkStringToNumeric ()
 
 ~vtkStringToNumeric ()
 
void ConvertArrays (vtkFieldData *fieldData)
 
int CountItemsToConvert (vtkFieldData *fieldData)
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 

Protected Attributes

bool ConvertFieldData
 
bool ConvertPointData
 
bool ConvertCellData
 
bool ForceDouble
 
int DefaultIntegerValue
 
double DefaultDoubleValue
 
bool TrimWhitespacePriorToNumericConversion
 
int ItemsToConvert
 
int ItemsConverted
 

Detailed Description

Converts string arrays to numeric arrays.

vtkStringToNumeric is a filter for converting a string array into a numeric arrays.

Examples:
vtkStringToNumeric (Examples)
Tests:
vtkStringToNumeric (Tests)

Definition at line 40 of file vtkStringToNumeric.h.

Member Typedef Documentation

typedef vtkDataObjectAlgorithm vtkStringToNumeric::Superclass

Definition at line 44 of file vtkStringToNumeric.h.

Constructor & Destructor Documentation

vtkStringToNumeric::vtkStringToNumeric ( )
protected
vtkStringToNumeric::~vtkStringToNumeric ( )
protected

Member Function Documentation

static vtkStringToNumeric* vtkStringToNumeric::New ( )
static
static int vtkStringToNumeric::IsTypeOf ( const char *  type)
static
virtual int vtkStringToNumeric::IsA ( const char *  type)
virtual
static vtkStringToNumeric* vtkStringToNumeric::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkStringToNumeric::NewInstanceInternal ( ) const
protectedvirtual
vtkStringToNumeric* vtkStringToNumeric::NewInstance ( ) const
void vtkStringToNumeric::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkStringToNumeric::SetForceDouble ( bool  )
virtual

Convert all numeric columns to vtkDoubleArray, even if they contain only integer values. Default is off.

virtual bool vtkStringToNumeric::GetForceDouble ( )
virtual

Convert all numeric columns to vtkDoubleArray, even if they contain only integer values. Default is off.

virtual void vtkStringToNumeric::ForceDoubleOn ( )
virtual

Convert all numeric columns to vtkDoubleArray, even if they contain only integer values. Default is off.

virtual void vtkStringToNumeric::ForceDoubleOff ( )
virtual

Convert all numeric columns to vtkDoubleArray, even if they contain only integer values. Default is off.

virtual void vtkStringToNumeric::SetDefaultIntegerValue ( int  )
virtual

Set the default integer value assigned to arrays. Default is 0.

virtual int vtkStringToNumeric::GetDefaultIntegerValue ( )
virtual

Set the default integer value assigned to arrays. Default is 0.

virtual void vtkStringToNumeric::SetDefaultDoubleValue ( double  )
virtual

Set the default double value assigned to arrays. Default is 0.0

virtual double vtkStringToNumeric::GetDefaultDoubleValue ( )
virtual

Set the default double value assigned to arrays. Default is 0.0

virtual void vtkStringToNumeric::SetTrimWhitespacePriorToNumericConversion ( bool  )
virtual

Whether to trim whitespace from strings prior to conversion to a numeric. Default is false to preserve backward compatibility. vtkVariant handles whitespace inconsistently, so trim it before we try to convert it. For example: vtkVariant(" 2.0").ToDouble() == 2.0 <– leading whitespace is not a problem vtkVariant(" 2.0 ").ToDouble() == NaN <– trailing whitespace is a problem vtkVariant(" infinity ").ToDouble() == NaN <– any whitespace is a problem In these cases, trimming the whitespace gives us the result we expect: 2.0 and INF respectively.

virtual bool vtkStringToNumeric::GetTrimWhitespacePriorToNumericConversion ( )
virtual

Whether to trim whitespace from strings prior to conversion to a numeric. Default is false to preserve backward compatibility. vtkVariant handles whitespace inconsistently, so trim it before we try to convert it. For example: vtkVariant(" 2.0").ToDouble() == 2.0 <– leading whitespace is not a problem vtkVariant(" 2.0 ").ToDouble() == NaN <– trailing whitespace is a problem vtkVariant(" infinity ").ToDouble() == NaN <– any whitespace is a problem In these cases, trimming the whitespace gives us the result we expect: 2.0 and INF respectively.

virtual void vtkStringToNumeric::TrimWhitespacePriorToNumericConversionOn ( )
virtual

Whether to trim whitespace from strings prior to conversion to a numeric. Default is false to preserve backward compatibility. vtkVariant handles whitespace inconsistently, so trim it before we try to convert it. For example: vtkVariant(" 2.0").ToDouble() == 2.0 <– leading whitespace is not a problem vtkVariant(" 2.0 ").ToDouble() == NaN <– trailing whitespace is a problem vtkVariant(" infinity ").ToDouble() == NaN <– any whitespace is a problem In these cases, trimming the whitespace gives us the result we expect: 2.0 and INF respectively.

virtual void vtkStringToNumeric::TrimWhitespacePriorToNumericConversionOff ( )
virtual

Whether to trim whitespace from strings prior to conversion to a numeric. Default is false to preserve backward compatibility. vtkVariant handles whitespace inconsistently, so trim it before we try to convert it. For example: vtkVariant(" 2.0").ToDouble() == 2.0 <– leading whitespace is not a problem vtkVariant(" 2.0 ").ToDouble() == NaN <– trailing whitespace is a problem vtkVariant(" infinity ").ToDouble() == NaN <– any whitespace is a problem In these cases, trimming the whitespace gives us the result we expect: 2.0 and INF respectively.

virtual void vtkStringToNumeric::SetConvertFieldData ( bool  )
virtual

Whether to detect and convert field data arrays. Default is on.

virtual bool vtkStringToNumeric::GetConvertFieldData ( )
virtual

Whether to detect and convert field data arrays. Default is on.

virtual void vtkStringToNumeric::ConvertFieldDataOn ( )
virtual

Whether to detect and convert field data arrays. Default is on.

virtual void vtkStringToNumeric::ConvertFieldDataOff ( )
virtual

Whether to detect and convert field data arrays. Default is on.

virtual void vtkStringToNumeric::SetConvertPointData ( bool  )
virtual

Whether to detect and convert cell data arrays. Default is on.

virtual bool vtkStringToNumeric::GetConvertPointData ( )
virtual

Whether to detect and convert cell data arrays. Default is on.

virtual void vtkStringToNumeric::ConvertPointDataOn ( )
virtual

Whether to detect and convert cell data arrays. Default is on.

virtual void vtkStringToNumeric::ConvertPointDataOff ( )
virtual

Whether to detect and convert cell data arrays. Default is on.

virtual void vtkStringToNumeric::SetConvertCellData ( bool  )
virtual

Whether to detect and convert point data arrays. Default is on.

virtual bool vtkStringToNumeric::GetConvertCellData ( )
virtual

Whether to detect and convert point data arrays. Default is on.

virtual void vtkStringToNumeric::ConvertCellDataOn ( )
virtual

Whether to detect and convert point data arrays. Default is on.

virtual void vtkStringToNumeric::ConvertCellDataOff ( )
virtual

Whether to detect and convert point data arrays. Default is on.

virtual void vtkStringToNumeric::SetConvertVertexData ( bool  b)
inlinevirtual

Whether to detect and convert vertex data arrays. Default is on.

Definition at line 105 of file vtkStringToNumeric.h.

virtual bool vtkStringToNumeric::GetConvertVertexData ( )
inlinevirtual

Whether to detect and convert vertex data arrays. Default is on.

Definition at line 107 of file vtkStringToNumeric.h.

virtual void vtkStringToNumeric::ConvertVertexDataOn ( )
virtual

Whether to detect and convert vertex data arrays. Default is on.

virtual void vtkStringToNumeric::ConvertVertexDataOff ( )
virtual

Whether to detect and convert vertex data arrays. Default is on.

virtual void vtkStringToNumeric::SetConvertEdgeData ( bool  b)
inlinevirtual

Whether to detect and convert edge data arrays. Default is on.

Definition at line 114 of file vtkStringToNumeric.h.

virtual bool vtkStringToNumeric::GetConvertEdgeData ( )
inlinevirtual

Whether to detect and convert edge data arrays. Default is on.

Definition at line 116 of file vtkStringToNumeric.h.

virtual void vtkStringToNumeric::ConvertEdgeDataOn ( )
virtual

Whether to detect and convert edge data arrays. Default is on.

virtual void vtkStringToNumeric::ConvertEdgeDataOff ( )
virtual

Whether to detect and convert edge data arrays. Default is on.

virtual void vtkStringToNumeric::SetConvertRowData ( bool  b)
inlinevirtual

Whether to detect and convert row data arrays. Default is on.

Definition at line 123 of file vtkStringToNumeric.h.

virtual bool vtkStringToNumeric::GetConvertRowData ( )
inlinevirtual

Whether to detect and convert row data arrays. Default is on.

Definition at line 125 of file vtkStringToNumeric.h.

virtual void vtkStringToNumeric::ConvertRowDataOn ( )
virtual

Whether to detect and convert row data arrays. Default is on.

virtual void vtkStringToNumeric::ConvertRowDataOff ( )
virtual

Whether to detect and convert row data arrays. Default is on.

virtual int vtkStringToNumeric::ProcessRequest ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
virtual

This is required to capture REQUEST_DATA_OBJECT requests.

virtual int vtkStringToNumeric::RequestDataObject ( vtkInformation *  request,
vtkInformationVector **  inputVector,
vtkInformationVector *  outputVector 
)
protectedvirtual

Creates the same output type as the input type.

void vtkStringToNumeric::ConvertArrays ( vtkFieldData *  fieldData)
protected

Tries to convert string arrays to integer or double arrays.

int vtkStringToNumeric::CountItemsToConvert ( vtkFieldData *  fieldData)
protected

Count the total number of items (array components) that will need to be converted in the given vtkFieldData. This lets us emit ProgressEvent.

int vtkStringToNumeric::RequestData ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

Member Data Documentation

bool vtkStringToNumeric::ConvertFieldData
protected

Definition at line 151 of file vtkStringToNumeric.h.

bool vtkStringToNumeric::ConvertPointData
protected

Definition at line 152 of file vtkStringToNumeric.h.

bool vtkStringToNumeric::ConvertCellData
protected

Definition at line 153 of file vtkStringToNumeric.h.

bool vtkStringToNumeric::ForceDouble
protected

Definition at line 154 of file vtkStringToNumeric.h.

int vtkStringToNumeric::DefaultIntegerValue
protected

Definition at line 155 of file vtkStringToNumeric.h.

double vtkStringToNumeric::DefaultDoubleValue
protected

Definition at line 156 of file vtkStringToNumeric.h.

bool vtkStringToNumeric::TrimWhitespacePriorToNumericConversion
protected

Definition at line 157 of file vtkStringToNumeric.h.

int vtkStringToNumeric::ItemsToConvert
protected

Definition at line 165 of file vtkStringToNumeric.h.

int vtkStringToNumeric::ItemsConverted
protected

Definition at line 166 of file vtkStringToNumeric.h.


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