VTK  9.3.20240723
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCellGridResponders Class Reference

A container that holds objects able to respond to queries specialized for particular vtkCellMetadata types. More...

#include <vtkCellGridResponders.h>

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

Classes

struct  CalculatorForTagSet
 A record of a registered calculator along with the tags it requires and values of those tags it will accept. More...
 

Public Types

using TagSet = std::unordered_map< vtkStringToken, std::unordered_set< vtkStringToken > >
 A map of tag names (such as the cell's type-name) to values of the tag accepted or provided for that tag.
 
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.
 
vtkCellGridRespondersNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
template<typename CellType , typename QueryType , typename ResponderType >
void RegisterQueryResponder (ResponderType *responder)
 Register responder for processing a cell's data.
 
bool Query (vtkCellMetadata *cellType, vtkCellGridQuery *query)
 Invoke a responder for the given query and cell type.
 
template<typename CellType , typename CalculatorType >
bool RegisterCalculator (vtkStringToken tags, vtkCellAttributeCalculator *calculator)
 Register a vtkCellAttributeCalculator subclass.
 
template<typename CellType , typename CalculatorType >
bool RegisterCalculator (vtkCellAttributeCalculator *calculator, const TagSet &tags)
 
vtkSmartPointer< vtkCellAttributeCalculatorAttributeCalculator (vtkStringToken calculatorType, vtkCellMetadata *cellType, vtkCellAttribute *attrib, const TagSet &tags) const
 Fetch an instance of an attribute calculator for the given tags.
 
template<typename CalculatorType >
vtkSmartPointer< CalculatorType > AttributeCalculator (vtkCellMetadata *cellType, vtkCellAttribute *cellAttribute) const
 
template<typename CalculatorType >
vtkSmartPointer< CalculatorType > AttributeCalculator (vtkCellMetadata *cellType, vtkCellAttribute *attrib, const TagSet &tags) const
 
vtkSmartPointer< vtkObjectGetCacheData (std::size_t key)
 Return a cache object given a key.
 
template<typename CacheType >
vtkSmartPointer< CacheType > GetCacheDataAs (std::size_t key, bool createIfAbsent=false)
 
bool SetCacheData (std::size_t key, vtkSmartPointer< vtkObject > value, bool overwrite=false)
 Add a cache entry mapping key to value.
 
- 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.
 
vtkCommandGetCommand (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 vtkCellGridRespondersNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridRespondersSafeDownCast (vtkObjectBase *o)
 
- 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.
 
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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkCellGridResponders ()=default
 
 ~vtkCellGridResponders () override=default
 
- 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 &)
 

Protected Attributes

std::unordered_map< vtkStringToken, std::unordered_map< vtkStringToken, vtkSmartPointer< vtkCellGridResponderBase > > > Responders
 
std::unordered_map< std::size_t, vtkSmartPointer< vtkObject > > Caches
 
std::unordered_map< vtkStringToken, std::vector< CalculatorForTagSet > > CalculatorRegistry
 A map from a calculator base class to a set of registered prototypes.
 
std::unordered_map< vtkStringToken, std::unordered_map< vtkStringToken, std::unordered_map< vtkStringToken, vtkSmartPointer< vtkCellAttributeCalculator > > > > Calculators
 Nested maps from cell-attribute-query-type to cell-type to cell-attribute-tag-sets to concrete query implementation.
 
- 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
 

Additional Inherited Members

- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 

Detailed Description

A container that holds objects able to respond to queries specialized for particular vtkCellMetadata types.

This class holds sets of responders for vtkCellGridQuery and for vtkCellAttributeQuery.

Cell-grid query responders

vtkCellGridResponders holds a list of objects statically registered to the vtkCellMetadata subclass. These objects respond to queries for information (e.g., a bounding box) or processing (e.g., rendering, picking, generating isocontours) for one cell type (and subclasses of that cell type if no more specific responder is registered).

Application code (such as a plugin) can register subclasses of vtkCellGridResponse which accept the API of a particular vtkCellGridQuery for that cell type. Then, when a query is passed to the cell, this collection will identify matching responders for the query and invoke them until one returns true (indicating success). Multiple matches can exist as a responder can be registered to a common base cell class and/or to handle common base query classes.

If a given cell type cannot respond to a query, its superclasses are asked to respond. If no superclass can respond to the query, then query's superclasses are searched for responders.

Because queries can be registered to cell types at any time, existing cell types can be extended to support new features by additional libraries.

Cell-attribute calculators

In order to support the evaluation of vtkCellAttribute data on any vtkCellMetadata (cell type), this class also holds "calculators" grouped by both attribute and cell type. This API is different that vtkCellGridQuery because vtkCellAttribute is not subclassed by attribute type but rather uses vtkStringToken data to determine the nature of the attribute (e.g., Lagrange; Nedelec; Raviart-Thomas; etc.).

It is also different in that these objects are expected to be used inside vtkCellGridQuery to evaluate a single cell at a time rather than longer-running queries across all cells.

See also
vtkCellMetadata vtkCellGrid vtkCellAttribute

Definition at line 72 of file vtkCellGridResponders.h.

Member Typedef Documentation

◆ TagSet

using vtkCellGridResponders::TagSet = std::unordered_map<vtkStringToken, std::unordered_set<vtkStringToken> >

A map of tag names (such as the cell's type-name) to values of the tag accepted or provided for that tag.

Definition at line 79 of file vtkCellGridResponders.h.

◆ Superclass

Definition at line 91 of file vtkCellGridResponders.h.

Constructor & Destructor Documentation

◆ vtkCellGridResponders()

vtkCellGridResponders::vtkCellGridResponders ( )
protecteddefault

◆ ~vtkCellGridResponders()

vtkCellGridResponders::~vtkCellGridResponders ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static vtkCellGridResponders * vtkCellGridResponders::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkCellGridResponders::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkCellGridResponders::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.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellGridResponders::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkCellGridResponders * vtkCellGridResponders::NewInstance ( ) const

◆ PrintSelf()

void vtkCellGridResponders::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.

◆ RegisterQueryResponder()

template<typename CellType , typename QueryType , typename ResponderType >
void vtkCellGridResponders::RegisterQueryResponder ( ResponderType *  responder)
inline

Register responder for processing a cell's data.

Definition at line 98 of file vtkCellGridResponders.h.

◆ Query()

bool vtkCellGridResponders::Query ( vtkCellMetadata cellType,
vtkCellGridQuery query 
)

Invoke a responder for the given query and cell type.

If none exists, return false.

◆ RegisterCalculator() [1/2]

template<typename CellType , typename CalculatorType >
bool vtkCellGridResponders::RegisterCalculator ( vtkStringToken  tags,
vtkCellAttributeCalculator calculator 
)
inline

Register a vtkCellAttributeCalculator subclass.

Calculators are meant to be lightweight objects that perform a computation on the combination of a single cell type and a single cell-attribute type – the latter identified by a set of tags indicating relevant properties of the cell-attribute.

Definition at line 121 of file vtkCellGridResponders.h.

◆ RegisterCalculator() [2/2]

template<typename CellType , typename CalculatorType >
bool vtkCellGridResponders::RegisterCalculator ( vtkCellAttributeCalculator calculator,
const TagSet tags 
)
inline

Definition at line 144 of file vtkCellGridResponders.h.

◆ AttributeCalculator() [1/3]

vtkSmartPointer< vtkCellAttributeCalculator > vtkCellGridResponders::AttributeCalculator ( vtkStringToken  calculatorType,
vtkCellMetadata cellType,
vtkCellAttribute attrib,
const TagSet tags 
) const

Fetch an instance of an attribute calculator for the given tags.

◆ AttributeCalculator() [2/3]

template<typename CalculatorType >
vtkSmartPointer< CalculatorType > vtkCellGridResponders::AttributeCalculator ( vtkCellMetadata cellType,
vtkCellAttribute cellAttribute 
) const
inline

Definition at line 175 of file vtkCellGridResponders.h.

◆ AttributeCalculator() [3/3]

template<typename CalculatorType >
vtkSmartPointer< CalculatorType > vtkCellGridResponders::AttributeCalculator ( vtkCellMetadata cellType,
vtkCellAttribute attrib,
const TagSet tags 
) const
inline

Definition at line 185 of file vtkCellGridResponders.h.

◆ GetCacheData()

vtkSmartPointer< vtkObject > vtkCellGridResponders::GetCacheData ( std::size_t  key)

Return a cache object given a key.

Objects held in this cache may live for the duration of an application, not a single query.

Cached objects are expected to invalidate themselves (say by using vtkCommand to observe events that should invalidate them).

◆ GetCacheDataAs()

template<typename CacheType >
vtkSmartPointer< CacheType > vtkCellGridResponders::GetCacheDataAs ( std::size_t  key,
bool  createIfAbsent = false 
)
inline

Definition at line 204 of file vtkCellGridResponders.h.

◆ SetCacheData()

bool vtkCellGridResponders::SetCacheData ( std::size_t  key,
vtkSmartPointer< vtkObject value,
bool  overwrite = false 
)

Add a cache entry mapping key to value.

If overwrite is true, this will release any pre-existing value (which may force its destruction).

This method returns true upon success and false otherwise. Failure will occur if overwrite is false and either

  • there is a pre-existing object at key that it not value; or
  • value is null (adding empty entries is forbidden).

Note that by passing a null value with overwrite set to true, you can clear an existing cache entry.

Member Data Documentation

◆ Responders

std::unordered_map<vtkStringToken, std::unordered_map<vtkStringToken, vtkSmartPointer<vtkCellGridResponderBase> > > vtkCellGridResponders::Responders
protected

Definition at line 241 of file vtkCellGridResponders.h.

◆ Caches

std::unordered_map<std::size_t, vtkSmartPointer<vtkObject> > vtkCellGridResponders::Caches
protected

Definition at line 243 of file vtkCellGridResponders.h.

◆ CalculatorRegistry

std::unordered_map<vtkStringToken, std::vector<CalculatorForTagSet> > vtkCellGridResponders::CalculatorRegistry
protected

A map from a calculator base class to a set of registered prototypes.

Definition at line 246 of file vtkCellGridResponders.h.

◆ Calculators

std::unordered_map<vtkStringToken, std::unordered_map<vtkStringToken, std::unordered_map<vtkStringToken, vtkSmartPointer<vtkCellAttributeCalculator> > > > vtkCellGridResponders::Calculators
protected

Nested maps from cell-attribute-query-type to cell-type to cell-attribute-tag-sets to concrete query implementation.

For example, AttributeQueries["vtkCellAttributeEvaluator"]["vtkDGTet"][{"HCurl", "I1"}] might return an object that subclasses vtkCellAttributeEvaluator and implements evaluation for HCurl fields defined on tetrahedral cells.

The set of string tokens stored as the third key in the nested map is matched for any field that contains all of the tags.

Definition at line 260 of file vtkCellGridResponders.h.


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