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

#include <vtkDataArraySelection.h>

Inheritance diagram for vtkDataArraySelection:

Collaboration diagram for vtkDataArraySelection:

Public Types
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkDataArraySelection *	NewInstance () const

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)


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)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual unsigned long	GetMTime ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkDataArraySelection *	SafeDownCast (vtkObjectBase *o)

static vtkDataArraySelection *	New ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

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

void	CopySelections (vtkDataArraySelection *selections)

	vtkDataArraySelection ()

	~vtkDataArraySelection ()

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

Member Typedef Documentation

typedef vtkObject vtkDataArraySelection::Superclass

Definition at line 36 of file vtkDataArraySelection.h.

Constructor & Destructor Documentation

vtkDataArraySelection::vtkDataArraySelection ( )

protected

Copy the selections from the given vtkDataArraySelection instance.

vtkDataArraySelection::~vtkDataArraySelection ( )

protected

Copy the selections from the given vtkDataArraySelection instance.

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

static vtkDataArraySelection* vtkDataArraySelection::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkDataArraySelection::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkObject.

vtkDataArraySelection* vtkDataArraySelection::NewInstance ( ) const

void vtkDataArraySelection::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 vtkObject.

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

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

/home/boeckb/code/depot/group-kitware/vtk/build-release/Utilities/Doxygen/dox/Common/Core/vtkDataArraySelection.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation