VTK
9.3.20241003
|
Store on/off settings for data arrays, etc. More...
#include <vtkDataArraySelection.h>
Public Types | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
vtkDataArraySelection * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | EnableArray (const char *name) |
Enable the array with the given name. | |
void | DisableArray (const char *name) |
Disable the array with the given name. | |
int | ArrayIsEnabled (const char *name) const |
Return whether the array with the given name is enabled. | |
int | ArrayExists (const char *name) const |
Return whether the array with the given name exists. | |
void | EnableAllArrays () |
Enable all arrays that currently have an entry. | |
void | DisableAllArrays () |
Disable all arrays that currently have an entry. | |
int | GetNumberOfArrays () const |
Get the number of arrays that currently have an entry. | |
int | GetNumberOfArraysEnabled () const |
Get the number of arrays that are enabled. | |
const char * | GetArrayName (int index) const |
Get the name of the array entry at the given index. | |
int | GetArrayIndex (const char *name) const |
Get an index of the array with the given name. | |
int | GetEnabledArrayIndex (const char *name) const |
Get the index of an array with the given name among those that are enabled. | |
int | GetArraySetting (int index) const |
Get whether the array at the given index is enabled. | |
int | GetArraySetting (const char *name) const |
Get whether the array is enabled/disable using its name. | |
void | SetArraySetting (const char *name, int setting) |
Set array setting given the name. | |
void | RemoveAllArrays () |
Remove all array entries. | |
int | AddArray (const char *name, bool state=true) |
Add to the list of arrays that have entries. | |
void | RemoveArrayByIndex (int index) |
Remove an array setting given its index. | |
void | RemoveArrayByName (const char *name) |
Remove an array setting given its name. | |
void | CopySelections (vtkDataArraySelection *selections) |
Copy the selections from the given vtkDataArraySelection instance. | |
void | DeepCopy (const vtkDataArraySelection *other) |
Copy contents of other. | |
bool | IsEqual (const vtkDataArraySelection *other) const |
Returns true if the two array selections are equivalent. | |
void | SetArrays (const char *const *names, int numArrays) |
Set the list of arrays that have entries. | |
void | SetArraysWithDefault (const char *const *names, int numArrays, int defaultStatus) |
Set the list of arrays that have entries. | |
void | Union (vtkDataArraySelection *other) |
Update this to include values from other . | |
void | Union (vtkDataArraySelection *other, bool skipModified) |
Update this to include values from other . | |
virtual void | SetUnknownArraySetting (int) |
Get/Set enabled state for any unknown arrays. | |
virtual int | GetUnknownArraySetting () |
Get/Set enabled state for any unknown arrays. | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. | |
virtual void | DebugOff () |
Turn debugging output off. | |
bool | GetDebug () |
Get the value of the debug flag. | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. | |
virtual void | Modified () |
Update the modification time for this object. | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. | |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
vtkTypeBool | InvokeEvent (unsigned long event) |
vtkTypeBool | InvokeEvent (const char *event) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. | |
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. | |
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. | |
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. | |
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. | |
virtual std::string | GetObjectDescription () const |
The object description printed in messages and PrintSelf output. | |
virtual vtkTypeBool | IsA (const char *name) |
Return 1 if this class is the same type of (or a subclass of) the named class. | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
virtual void | Delete () |
Delete a VTK object. | |
virtual void | FastDelete () |
Delete a reference to this object. | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. | |
void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). | |
int | GetReferenceCount () |
Return the current reference count of this object. | |
void | SetReferenceCount (int) |
Sets the reference count. | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. | |
virtual bool | UsesGarbageCollector () const |
Indicate whether the class uses vtkGarbageCollector or not. | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkDataArraySelection * | SafeDownCast (vtkObjectBase *o) |
static vtkDataArraySelection * | New () |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. | |
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
static vtkTypeBool | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. | |
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. | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () 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. | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) |
virtual void | ReportReferences (vtkGarbageCollector *) |
virtual void | ObjectFinalize () |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
Protected Attributes inherited from vtkObjectBase | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Store on/off settings for data arrays, etc.
vtkDataArraySelection is intended to be used by algorithms that want to expose a API that allow the user to enable/disable a collection of entities, such as arrays. Readers, for example, can use vtkDataArraySelection to let the user choose which array to read from the file.
Originally intended for selecting data arrays (hence the name), this class can be used for letting users choose other items too, for example, vtkIOSSReader uses vtkDataArraySelection to let users choose which blocks to read.
Unlike most other vtkObject subclasses, vtkDataArraySelection has public API that need not modify the MTime for the object. These M-Time non-modifying methods are typically intended for use within the algorithm or reader to populate the vtkDataArraySelection instance with available array names and their default values.
Definition at line 36 of file vtkDataArraySelection.h.
Definition at line 39 of file vtkDataArraySelection.h.
|
protected |
|
overrideprotected |
|
static |
|
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 |
|
protectedvirtual |
vtkDataArraySelection * vtkDataArraySelection::NewInstance | ( | ) | const |
|
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 |
void vtkDataArraySelection::EnableArray | ( | const char * | name | ) |
Enable the array with the given name.
Creates a new entry if none exists.
This method will call this->Modified()
if the enable state for the array changed.
void vtkDataArraySelection::DisableArray | ( | const char * | name | ) |
Disable the array with the given name.
Creates a new entry if none exists.
This method will call this->Modified()
if the enable state for the array changed.
int vtkDataArraySelection::ArrayIsEnabled | ( | const char * | name | ) | const |
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 | ) | const |
Return whether the array with the given name exists.
void vtkDataArraySelection::EnableAllArrays | ( | ) |
Enable all arrays that currently have an entry.
This method will call this->Modified()
if the enable state for any of the known arrays is changed.
void vtkDataArraySelection::DisableAllArrays | ( | ) |
Disable all arrays that currently have an entry.
This method will call this->Modified()
if the enable state for any of the known arrays is changed.
int vtkDataArraySelection::GetNumberOfArrays | ( | ) | const |
Get the number of arrays that currently have an entry.
int vtkDataArraySelection::GetNumberOfArraysEnabled | ( | ) | const |
Get the number of arrays that are enabled.
const char * vtkDataArraySelection::GetArrayName | ( | int | index | ) | const |
Get the name of the array entry at the given index.
int vtkDataArraySelection::GetArrayIndex | ( | const char * | name | ) | const |
Get an index of the array with the given name.
int vtkDataArraySelection::GetEnabledArrayIndex | ( | const char * | name | ) | const |
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 | ( | int | index | ) | const |
Get whether the array at the given index is enabled.
|
inline |
Get whether the array is enabled/disable using its name.
Definition at line 122 of file vtkDataArraySelection.h.
void vtkDataArraySelection::SetArraySetting | ( | const char * | name, |
int | setting | ||
) |
Set array setting given the name.
If the array doesn't exist, it will be added.
This method will call this->Modified()
if the enable state for the array changed.
void vtkDataArraySelection::RemoveAllArrays | ( | ) |
Remove all array entries.
This method will call this->Modified()
if the arrays were cleared.
int vtkDataArraySelection::AddArray | ( | const char * | name, |
bool | state = true |
||
) |
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 by default. The state can also be passed as the second argument. This method should be called only by the filter owning this object.
This method does not call this->Modified()
.
Also note for arrays already known to this instance (i.e. this->ArrayExists(name) == true
, this method has no effect.
void vtkDataArraySelection::RemoveArrayByIndex | ( | int | index | ) |
Remove an array setting given its index.
This method does not call this->Modified()
.
void vtkDataArraySelection::RemoveArrayByName | ( | const char * | name | ) |
Remove an array setting given its name.
This method does not call this->Modified()
.
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.
This method does not call this->Modified()
.
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.
This method does not call this->Modified()
.
void vtkDataArraySelection::CopySelections | ( | vtkDataArraySelection * | selections | ) |
Copy the selections from the given vtkDataArraySelection instance.
This method will call this->Modified()
if the array selections changed.
|
inline |
Update this
to include values from other
.
For arrays that don't exist in this
but exist in other
, they will get added to this
with the same array setting as in other
. Array settings for arrays already in this
are left unchanged.
This method will call this->Modified()
if the array selections changed unless skipModified is set to true (default is false).
Definition at line 203 of file vtkDataArraySelection.h.
void vtkDataArraySelection::Union | ( | vtkDataArraySelection * | other, |
bool | skipModified | ||
) |
Update this
to include values from other
.
For arrays that don't exist in this
but exist in other
, they will get added to this
with the same array setting as in other
. Array settings for arrays already in this
are left unchanged.
This method will call this->Modified()
if the array selections changed unless skipModified is set to true (default is false).
|
virtual |
Get/Set enabled state for any unknown arrays.
Default is 0 i.e. not enabled. When set to 1, ArrayIsEnabled
will return 1 for any array not explicitly specified.
|
virtual |
Get/Set enabled state for any unknown arrays.
Default is 0 i.e. not enabled. When set to 1, ArrayIsEnabled
will return 1 for any array not explicitly specified.
void vtkDataArraySelection::DeepCopy | ( | const vtkDataArraySelection * | other | ) |
Copy contents of other.
The MTime for this instance is modified only if values are different.
bool vtkDataArraySelection::IsEqual | ( | const vtkDataArraySelection * | other | ) | const |
Returns true if the two array selections are equivalent.