vtkDataArraySelection Class Reference
#include <vtkDataArraySelection.h>
Detailed Description
Store on/off settings for data arrays for a vtkSource.vtkDataArraySelection can be used by vtkSource subclasses to store on/off settings for whether each vtkDataArray in its input should be passed in the source's output. This is primarily intended to allow file readers to configure what data arrays are read from the file.
Definition at line 32 of file vtkDataArraySelection.h.
Public Types | |
| typedef vtkObject | Superclass |
Public Member Functions | |
| virtual const char * | GetClassName () |
| virtual int | IsA (const char *type) |
| void | PrintSelf (ostream &os, vtkIndent indent) |
| void | EnableArray (const char *name) |
| void | DisableArray (const char *name) |
| int | ArrayIsEnabled (const char *name) |
| int | ArrayExists (const char *name) |
| void | EnableAllArrays () |
| void | DisableAllArrays () |
| int | GetNumberOfArrays () |
| int | GetNumberOfArraysEnabled () |
| const char * | GetArrayName (int index) |
| int | GetArrayIndex (const char *name) |
| int | GetEnabledArrayIndex (const char *name) |
| void | RemoveAllArrays () |
| int | AddArray (const char *name) |
| void | RemoveArrayByIndex (int index) |
| void | RemoveArrayByName (const char *name) |
| void | CopySelections (vtkDataArraySelection *selections) |
| int | GetArraySetting (const char *name) |
| int | GetArraySetting (int index) |
| void | SetArrays (const char *const *names, int numArrays) |
| void | SetArraysWithDefault (const char *const *names, int numArrays, int defaultStatus) |
Static Public Member Functions | |
| static int | IsTypeOf (const char *type) |
| static vtkDataArraySelection * | SafeDownCast (vtkObject *o) |
| static vtkDataArraySelection * | New () |
Protected Member Functions | |
| vtkDataArraySelection () | |
| ~vtkDataArraySelection () | |
Protected Attributes | |
| vtkDataArraySelectionInternals * | Internal |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkDataArraySelection::vtkDataArraySelection | ( | ) | [protected] |
| vtkDataArraySelection::~vtkDataArraySelection | ( | ) | [protected] |
Member Function Documentation
| virtual const char* vtkDataArraySelection::GetClassName | ( | ) | [virtual] |
Reimplemented from vtkObject.
| static int vtkDataArraySelection::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 vtkObject.
| virtual int vtkDataArraySelection::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 vtkObject.
| static vtkDataArraySelection* vtkDataArraySelection::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
| void vtkDataArraySelection::PrintSelf | ( | ostream & | os, | |
| vtkIndent | indent | |||
| ) | [virtual] |
| static vtkDataArraySelection* vtkDataArraySelection::New | ( | ) | [static] |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
Reimplemented from vtkObject.
| void vtkDataArraySelection::EnableArray | ( | const char * | name | ) |
Enable the array with the given name. Creates a new entry if none exists.
| void vtkDataArraySelection::DisableArray | ( | const char * | name | ) |
Disable the array with the given name. Creates a new entry if none exists.
| int vtkDataArraySelection::ArrayIsEnabled | ( | const char * | name | ) |
Return whether the array with the given name is enabled. If there is no entry, the array is assumed to be disabled.
| int vtkDataArraySelection::ArrayExists | ( | const char * | name | ) |
Return whether the array with the given name exists.
| void vtkDataArraySelection::EnableAllArrays | ( | ) |
Enable all arrays that currently have an entry.
| void vtkDataArraySelection::DisableAllArrays | ( | ) |
Disable all arrays that currently have an entry.
| int vtkDataArraySelection::GetNumberOfArrays | ( | ) |
Get the number of arrays that currently have an entry.
| int vtkDataArraySelection::GetNumberOfArraysEnabled | ( | ) |
Get the number of arrays that are enabled.
| const char* vtkDataArraySelection::GetArrayName | ( | int | index | ) |
Get the name of the array entry at the given index.
| int vtkDataArraySelection::GetArrayIndex | ( | const char * | name | ) |
Get an index of the array containing name within the enabled arrays
| int vtkDataArraySelection::GetEnabledArrayIndex | ( | const char * | name | ) |
Get the index of an array with the given name among those that are enabled. Returns -1 if the array is not enabled.
| int vtkDataArraySelection::GetArraySetting | ( | const char * | name | ) | [inline] |
Get whether the array at the given index is enabled.
Definition at line 78 of file vtkDataArraySelection.h.
| int vtkDataArraySelection::GetArraySetting | ( | int | index | ) |
Get whether the array at the given index is enabled.
| void vtkDataArraySelection::RemoveAllArrays | ( | ) |
Remove all array entries.
| int vtkDataArraySelection::AddArray | ( | const char * | name | ) |
Add to the list of arrays that have entries. For arrays that already have entries, the settings are untouched. For arrays that don't already have an entry, they are assumed to be enabled. This method should be called only by the filter owning this object.
| void vtkDataArraySelection::RemoveArrayByIndex | ( | int | index | ) |
Remove an array setting given its index.
| void vtkDataArraySelection::RemoveArrayByName | ( | const char * | name | ) |
Remove an array setting given its name.
| void vtkDataArraySelection::SetArrays | ( | const char *const * | names, | |
| int | numArrays | |||
| ) |
Set the list of arrays that have entries. For arrays that already have entries, the settings are copied. For arrays that don't already have an entry, they are assigned the given default status. If no default status is given, it is assumed to be on. There will be no more entries than the names given. This method should be called only by the filter owning this object. The signature with the default must have a different name due to a bug in the Borland C++ 5.5 compiler.
| void vtkDataArraySelection::SetArraysWithDefault | ( | const char *const * | names, | |
| int | numArrays, | |||
| int | defaultStatus | |||
| ) |
Set the list of arrays that have entries. For arrays that already have entries, the settings are copied. For arrays that don't already have an entry, they are assigned the given default status. If no default status is given, it is assumed to be on. There will be no more entries than the names given. This method should be called only by the filter owning this object. The signature with the default must have a different name due to a bug in the Borland C++ 5.5 compiler.
| void vtkDataArraySelection::CopySelections | ( | vtkDataArraySelection * | selections | ) |
Copy the selections from the given vtkDataArraySelection instance.
Member Data Documentation
vtkDataArraySelectionInternals* vtkDataArraySelection::Internal [protected] |
Definition at line 123 of file vtkDataArraySelection.h.
The documentation for this class was generated from the following file:
- dox/Common/vtkDataArraySelection.h
