VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkDataArraySelection Class Reference

Store on/off settings for data arrays for a vtkSource. More...

#include <vtkDataArraySelection.h>

Inheritance diagram for vtkDataArraySelection:
[legend]
Collaboration diagram for vtkDataArraySelection:
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkDataArraySelectionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void EnableArray (const char *name)
 Enable the array with the given name. More...
 
void DisableArray (const char *name)
 Disable the array with the given name. More...
 
int ArrayIsEnabled (const char *name)
 Return whether the array with the given name is enabled. More...
 
int ArrayExists (const char *name)
 Return whether the array with the given name exists. More...
 
void EnableAllArrays ()
 Enable all arrays that currently have an entry. More...
 
void DisableAllArrays ()
 Disable all arrays that currently have an entry. More...
 
int GetNumberOfArrays ()
 Get the number of arrays that currently have an entry. More...
 
int GetNumberOfArraysEnabled ()
 Get the number of arrays that are enabled. More...
 
const char * GetArrayName (int index)
 Get the name of the array entry at the given index. More...
 
int GetArrayIndex (const char *name)
 Get an index of the array with the given name. More...
 
int GetEnabledArrayIndex (const char *name)
 Get the index of an array with the given name among those that are enabled. More...
 
void RemoveAllArrays ()
 Remove all array entries. More...
 
int AddArray (const char *name)
 Add to the list of arrays that have entries. More...
 
void RemoveArrayByIndex (int index)
 Remove an array setting given its index. More...
 
void RemoveArrayByName (const char *name)
 Remove an array setting given its name. More...
 
void CopySelections (vtkDataArraySelection *selections)
 Copy the selections from the given vtkDataArraySelection instance. More...
 
int GetArraySetting (const char *name)
 Get whether the array at the given index is enabled. More...
 
int GetArraySetting (int index)
 Get whether the array at the given index is enabled. More...
 
void SetArrays (const char *const *names, int numArrays)
 Set the list of arrays that have entries. More...
 
void SetArraysWithDefault (const char *const *names, int numArrays, int defaultStatus)
 Set the list of arrays that have entries. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkDataArraySelectionSafeDownCast (vtkObjectBase *o)
 
static vtkDataArraySelectionNew ()
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataArraySelection ()
 
 ~vtkDataArraySelection () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
 ~vtkObject () override
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr)
 These methods allow a command to exclusively grab all events. More...
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkDataArraySelectionInternals * Internal
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

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 34 of file vtkDataArraySelection.h.

Member Typedef Documentation

Definition at line 37 of file vtkDataArraySelection.h.

Constructor & Destructor Documentation

vtkDataArraySelection::vtkDataArraySelection ( )
protected
vtkDataArraySelection::~vtkDataArraySelection ( )
overrideprotected

Member Function Documentation

static int vtkDataArraySelection::IsTypeOf ( const char *  type)
static
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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObjectBase.

static vtkDataArraySelection* vtkDataArraySelection::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkDataArraySelection::NewInstanceInternal ( ) const
protectedvirtual
vtkDataArraySelection* vtkDataArraySelection::NewInstance ( ) const
void vtkDataArraySelection::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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 vtkObjectBase.

static vtkDataArraySelection* vtkDataArraySelection::New ( )
static
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 with the given name.

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 104 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 161 of file vtkDataArraySelection.h.


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