VTK  9.4.20241230
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkCellGridCellCenters::Query Class Reference

A query corresponding to this algorithm. More...

#include <vtkCellGridCellCenters.h>

Inheritance diagram for vtkCellGridCellCenters::Query:
[legend]
Collaboration diagram for vtkCellGridCellCenters::Query:
[legend]

Public Types

enum  PassType : int { CountOutputs = 0 , AllocateOutputs = 1 , GenerateOutputs = 2 }
 
typedef vtkCellGridQuery Superclass
 
using OutputAllocations = std::unordered_map< vtkStringToken, std::unordered_map< vtkStringToken, vtkIdType > >
 A map used to allocate output vertex cells for various input cell types.
 
- Public Types inherited from vtkCellGridQuery
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.
 
vtkCellGridCellCenters::QueryNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
bool Initialize () override
 Override this if your query-result state requires initialization.
 
bool IsAnotherPassRequired () override
 Force three passes through this query.
 
vtkCellGridGetOutput () const
 Get the request's output cell-grid.
 
vtkCellGridGetInput () const
 Get the request's input cell-grid.
 
void AddOutputCenters (vtkStringToken inputCellType, vtkStringToken outputCellType, vtkIdType numberOfOutputs)
 Responders should call this method during the CountOutputs pass to allocate space in an output cell type.
 
OutputAllocationsGetOutputAllocations ()
 Return the data structure that AddOutputCenters() modifies in the PassType::CountOutputs pass.
 
const OutputAllocationsGetOutputAllocations () const
 
vtkCellAttributeGetOutputAttribute (vtkCellAttribute *inputAttribute)
 Return an output attribute (or null).
 
- Public Member Functions inherited from vtkCellGridQuery
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkCellGridQueryNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual bool Initialize ()
 Override this if your query-result state requires initialization.
 
virtual void StartPass ()
 Mark the start of a pass through each cell type.
 
virtual int GetPass ()
 Return the current pass (the number of times each responder has been evaluated so far).
 
virtual bool IsAnotherPassRequired ()
 Override this if your query allows responders to execute in multiple phases.
 
virtual bool Finalize ()
 Override this if your query-result state requires finalization.
 
- 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 QueryNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridCellCenters::QuerySafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkCellGridQuery
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCellGridQuerySafeDownCast (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
 
 Query ()=default
 
 ~Query () override=default
 
- Protected Member Functions inherited from vtkCellGridQuery
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCellGridQuery ()=default
 
 ~vtkCellGridQuery () 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

vtkCellGridInput { nullptr }
 
vtkCellGridOutput { nullptr }
 
OutputAllocations OutputOffsets
 Map output cell-typename to input cell-typename to count (offset after the AllocateOutputs pass has run).
 
std::unordered_map< vtkCellAttribute *, vtkCellAttribute * > AttributeMap
 
- Protected Attributes inherited from vtkCellGridQuery
int Pass { -1 }
 
- 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
 

Friends

class vtkCellGridCellCenters
 

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 query corresponding to this algorithm.

This query gets run on the input cell-grid.

Definition at line 34 of file vtkCellGridCellCenters.h.

Member Typedef Documentation

◆ Superclass

Definition at line 38 of file vtkCellGridCellCenters.h.

◆ OutputAllocations

A map used to allocate output vertex cells for various input cell types.

Definition at line 42 of file vtkCellGridCellCenters.h.

Member Enumeration Documentation

◆ PassType

Enumerator
CountOutputs 
AllocateOutputs 
GenerateOutputs 

Definition at line 45 of file vtkCellGridCellCenters.h.

Constructor & Destructor Documentation

◆ Query()

vtkCellGridCellCenters::Query::Query ( )
protecteddefault

◆ ~Query()

vtkCellGridCellCenters::Query::~Query ( )
overrideprotecteddefault

Member Function Documentation

◆ New()

static Query * vtkCellGridCellCenters::Query::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkCellGridCellCenters::Query::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkCellGridCellCenters::Query::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 vtkCellGridQuery.

◆ SafeDownCast()

static vtkCellGridCellCenters::Query * vtkCellGridCellCenters::Query::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellGridCellCenters::Query::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCellGridQuery.

◆ NewInstance()

vtkCellGridCellCenters::Query * vtkCellGridCellCenters::Query::NewInstance ( ) const

◆ PrintSelf()

void vtkCellGridCellCenters::Query::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.

◆ Initialize()

bool vtkCellGridCellCenters::Query::Initialize ( )
overridevirtual

Override this if your query-result state requires initialization.

You may override this method to do additional work, but you must be careful to call the base method from your override.

Returning false will abort processing of the query. No error message will be printed.

Reimplemented from vtkCellGridQuery.

◆ IsAnotherPassRequired()

bool vtkCellGridCellCenters::Query::IsAnotherPassRequired ( )
inlineoverridevirtual

Force three passes through this query.

Reimplemented from vtkCellGridQuery.

Definition at line 55 of file vtkCellGridCellCenters.h.

◆ GetOutput()

vtkCellGrid * vtkCellGridCellCenters::Query::GetOutput ( ) const
inline

Get the request's output cell-grid.

Definition at line 58 of file vtkCellGridCellCenters.h.

◆ GetInput()

vtkCellGrid * vtkCellGridCellCenters::Query::GetInput ( ) const
inline

Get the request's input cell-grid.

Definition at line 60 of file vtkCellGridCellCenters.h.

◆ AddOutputCenters()

void vtkCellGridCellCenters::Query::AddOutputCenters ( vtkStringToken  inputCellType,
vtkStringToken  outputCellType,
vtkIdType  numberOfOutputs 
)

Responders should call this method during the CountOutputs pass to allocate space in an output cell type.

◆ GetOutputAllocations() [1/2]

OutputAllocations & vtkCellGridCellCenters::Query::GetOutputAllocations ( )
inline

Return the data structure that AddOutputCenters() modifies in the PassType::CountOutputs pass.

Definition at line 69 of file vtkCellGridCellCenters.h.

◆ GetOutputAllocations() [2/2]

const OutputAllocations & vtkCellGridCellCenters::Query::GetOutputAllocations ( ) const
inline

Definition at line 70 of file vtkCellGridCellCenters.h.

◆ GetOutputAttribute()

vtkCellAttribute * vtkCellGridCellCenters::Query::GetOutputAttribute ( vtkCellAttribute inputAttribute)

Return an output attribute (or null).

Friends And Related Symbol Documentation

◆ vtkCellGridCellCenters

friend class vtkCellGridCellCenters
friend

Definition at line 76 of file vtkCellGridCellCenters.h.

Member Data Documentation

◆ Input

vtkCellGrid* vtkCellGridCellCenters::Query::Input { nullptr }
protected

Definition at line 80 of file vtkCellGridCellCenters.h.

◆ Output

vtkCellGrid* vtkCellGridCellCenters::Query::Output { nullptr }
protected

Definition at line 81 of file vtkCellGridCellCenters.h.

◆ OutputOffsets

OutputAllocations vtkCellGridCellCenters::Query::OutputOffsets
protected

Map output cell-typename to input cell-typename to count (offset after the AllocateOutputs pass has run).

Definition at line 85 of file vtkCellGridCellCenters.h.

◆ AttributeMap

std::unordered_map<vtkCellAttribute*, vtkCellAttribute*> vtkCellGridCellCenters::Query::AttributeMap
protected

Definition at line 87 of file vtkCellGridCellCenters.h.


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