VTK  9.0.20210422
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkDataAssemblyVisitor Class Referenceabstract

visitor API for vtkDataAssembly More...

#include <vtkDataAssemblyVisitor.h>

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

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. More...
 
vtkDataAssemblyVisitorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 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)
 
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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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 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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataAssemblyVisitorSafeDownCast (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. 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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataAssemblyVisitor ()
 
 ~vtkDataAssemblyVisitor () override
 
const vtkDataAssemblyGetAssembly () const
 Provides access to the assembly during traversal, otherwise returns nullptr. More...
 
int GetTraversalOrder () const
 Returns the current traversal order. More...
 
virtual void Visit (int nodeid)=0
 Called on every node being visited. More...
 
virtual bool GetTraverseSubtree (int vtkNotUsed(nodeid))
 Called to check if the subtree anchored at nodeid is to be traversed. More...
 
virtual void BeginSubTree (int vtkNotUsed(nodeid))
 Methods called at the start and end of a subtree traversal. More...
 
virtual void EndSubTree (int vtkNotUsed(nodeid))
 Methods called at the start and end of a subtree traversal. More...
 
const char * GetCurrentNodeName () const
 API to access information from the current node being processed. More...
 
std::vector< unsigned int > GetCurrentDataSetIndices () const
 API to access information from the current node being processed. More...
 
- 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 ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Friends

class vtkDataAssembly
 

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
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

visitor API for vtkDataAssembly

vtkDataAssemblyVisitor defines a visitor API for vtkDataAssembly. A concrete subclass of vtkDataAssemblyVisitor can be passed to vtkDataAssembly::Visit to execute custom code on each node in the data-assembly.

vtkDataAssembly::Visit will call vtkDataAssemblyVisitor::Visit on each node in the assembly (or chosen subtree). The traversal order, i.e. depth-first or breadth-first, is selected by the arguments passed to vtkDataAssembly::Visit. Before traversing a sub-tree for a particular node, vtkDataAssemblyVisitor::GetTraverseSubtree is called, if it returns false, the subtree is skipped. If it returns true, then then vtkDataAssemblyVisitor::BeginSubTree is called, followed by calls to vtkDataAssemblyVisitor::Visit for each of the child nodes, and finally vtkDataAssemblyVisitor::EndSubTree is called.

In depth-first order, the subtree traversal is recursive. Thus, after BeginSubTree is called for specific node, all its children and their subtrees are traversed before EndSubTree gets called for that node.

In breadth-first order, a first-in-first-out queue is used. A node is visited, i.e. vtkDataAssemblyVisitor::Visit called on it, then if GetTraverseSubtree returns true, Visit gets called on all its immediate children one after another followed by EndSubTree on the parent node. As each of the child nodes are visited, they get added to the queue. Now, for each node in the queue, the process repeats i.e. GetTraverseSubtree is called, followed by the subtree traversal for that node. This continues until the queue empty.

See also
vtkDataAssembly

Definition at line 59 of file vtkDataAssemblyVisitor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 62 of file vtkDataAssemblyVisitor.h.

Constructor & Destructor Documentation

◆ vtkDataAssemblyVisitor()

vtkDataAssemblyVisitor::vtkDataAssemblyVisitor ( )
protected

◆ ~vtkDataAssemblyVisitor()

vtkDataAssemblyVisitor::~vtkDataAssemblyVisitor ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkDataAssemblyVisitor::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 vtkDataAssemblyVisitor* vtkDataAssemblyVisitor::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkDataAssemblyVisitor::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkDataAssemblyVisitor* vtkDataAssemblyVisitor::NewInstance ( ) const

◆ PrintSelf()

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

◆ GetAssembly()

const vtkDataAssembly* vtkDataAssemblyVisitor::GetAssembly ( ) const
inlineprotected

Provides access to the assembly during traversal, otherwise returns nullptr.

Definition at line 73 of file vtkDataAssemblyVisitor.h.

◆ GetTraversalOrder()

int vtkDataAssemblyVisitor::GetTraversalOrder ( ) const
inlineprotected

Returns the current traversal order.

Definition at line 78 of file vtkDataAssemblyVisitor.h.

◆ Visit()

virtual void vtkDataAssemblyVisitor::Visit ( int  nodeid)
protectedpure virtual

Called on every node being visited.

  • nodeid is the id of the node being visited.

◆ GetTraverseSubtree()

virtual bool vtkDataAssemblyVisitor::GetTraverseSubtree ( int   vtkNotUsednodeid)
inlineprotectedvirtual

Called to check if the subtree anchored at nodeid is to be traversed.

Default implementation returns true. Subclasses can override this method to skip traversing 'dead' branches.

Definition at line 92 of file vtkDataAssemblyVisitor.h.

◆ BeginSubTree()

virtual void vtkDataAssemblyVisitor::BeginSubTree ( int   vtkNotUsednodeid)
inlineprotectedvirtual

Methods called at the start and end of a subtree traversal.

Definition at line 98 of file vtkDataAssemblyVisitor.h.

◆ EndSubTree()

virtual void vtkDataAssemblyVisitor::EndSubTree ( int   vtkNotUsednodeid)
inlineprotectedvirtual

Methods called at the start and end of a subtree traversal.

Definition at line 99 of file vtkDataAssemblyVisitor.h.

◆ GetCurrentNodeName()

const char* vtkDataAssemblyVisitor::GetCurrentNodeName ( ) const
protected

API to access information from the current node being processed.

It's preferred to use this API rather than API on vtkDataAssembly when working with the current node for improved performance.

◆ GetCurrentDataSetIndices()

std::vector<unsigned int> vtkDataAssemblyVisitor::GetCurrentDataSetIndices ( ) const
protected

API to access information from the current node being processed.

It's preferred to use this API rather than API on vtkDataAssembly when working with the current node for improved performance.

Friends And Related Function Documentation

◆ vtkDataAssembly

friend class vtkDataAssembly
friend

Definition at line 121 of file vtkDataAssemblyVisitor.h.


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