VTK  9.3.20241003
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkHyperTreeGridOrientedCursor Class Reference

Objects for traversal a HyperTreeGrid. More...

#include <vtkHyperTreeGridOrientedCursor.h>

Inheritance diagram for vtkHyperTreeGridOrientedCursor:
[legend]
Collaboration diagram for vtkHyperTreeGridOrientedCursor:
[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.
 
vtkHyperTreeGridOrientedCursorNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkHyperTreeGridOrientedCursorClone ()
 Create a copy of ‘this’.
 
vtkIdType GetVertexId ()
 Return the index of the current vertex in the tree.
 
vtkIdType GetGlobalNodeIndex ()
 Return the global index (relative to the grid) of the current vertex in the tree.
 
unsigned char GetDimension ()
 Return the dimension of the tree.
 
unsigned char GetNumberOfChildren ()
 Return the number of children for each node (non-vertex leaf) of the tree.
 
void SetGlobalIndexStart (vtkIdType index)
 
void SetGlobalIndexFromLocal (vtkIdType index)
 
void SetMask (bool state)
 Set the blanking mask is empty or not.
 
bool IsMasked ()
 Determine whether blanking mask is empty or not.
 
bool IsLeaf ()
 Is the cursor pointing to a leaf?
 
void SubdivideLeaf ()
 
bool IsRoot ()
 Is the cursor at tree root?
 
unsigned int GetLevel ()
 Get the level of the tree vertex pointed by the cursor.
 
void ToChild (unsigned char ichild)
 Move the cursor to child ‘child’ of the current vertex.
 
void Initialize (vtkHyperTreeGrid *grid, vtkIdType treeIndex, bool create=false)
 Initialize cursor at root of given tree index in grid.
 
void Initialize (vtkHyperTreeGrid *grid, vtkHyperTree *tree, unsigned int level, vtkIdType index)
 Initialize cursor at root of given tree index in grid.
 
void Initialize (vtkHyperTreeGrid *grid, vtkHyperTree *tree, unsigned int level, vtkHyperTreeGridEntry &entry)
 Initialize cursor at root of given tree index in grid.
 
vtkHyperTreeGridGetGrid ()
 Set the hyper tree grid to which the cursor is pointing.
 
bool HasTree () const
 Return if a Tree pointing exist.
 
vtkHyperTreeGetTree () const
 Set the hyper tree to which the cursor is pointing.
 
- 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 vtkTypeBool IsTypeOf (const char *type)
 
static vtkHyperTreeGridOrientedCursorSafeDownCast (vtkObjectBase *o)
 
static vtkHyperTreeGridOrientedCursorNew ()
 
- 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
 
 vtkHyperTreeGridOrientedCursor ()
 Constructor.
 
 ~vtkHyperTreeGridOrientedCursor () override
 Destructor.
 
- 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

vtkHyperTreeGridGrid
 Reference to the HTG currently processed.
 
vtkHyperTreeTree
 
unsigned int Level
 
vtkHyperTreeGridEntry Entry
 
- 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

Objects for traversal a HyperTreeGrid.

Objects that can perform depth traversal of a hyper tree grid, take into account more parameters (related to the grid structure) than the compact hyper tree cursor implemented in vtkHyperTree can. This is an abstract class. Cursors are created by the HyperTreeGrid implementation.

oriented cursors are used for simple recursive DFS. A cursor has no knowledge of its parent, only its children.

See also
vtkHyperTree vtkHyperTreeGrid
Thanks:
This class was written by Guenole Harel and Jacques-Bernard Lekien, 2014. This class was re-written by Philippe Pebay, 2016. This class was re-written for more optimisation by Jacques-Bernard Lekien, Guenole Harel and Jerome Dubois, 2018. This work was supported by Commissariat a l'Energie Atomique CEA, DAM, DIF, F-91297 Arpajon, France.
Tests:
vtkHyperTreeGridOrientedCursor (Tests)

Definition at line 42 of file vtkHyperTreeGridOrientedCursor.h.

Member Typedef Documentation

◆ Superclass

Definition at line 45 of file vtkHyperTreeGridOrientedCursor.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGridOrientedCursor()

vtkHyperTreeGridOrientedCursor::vtkHyperTreeGridOrientedCursor ( )
protected

Constructor.

◆ ~vtkHyperTreeGridOrientedCursor()

vtkHyperTreeGridOrientedCursor::~vtkHyperTreeGridOrientedCursor ( )
overrideprotected

Destructor.

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkHyperTreeGridOrientedCursor::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkHyperTreeGridOrientedCursor * vtkHyperTreeGridOrientedCursor::NewInstance ( ) const

◆ PrintSelf()

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

◆ New()

static vtkHyperTreeGridOrientedCursor * vtkHyperTreeGridOrientedCursor::New ( )
static

◆ Clone()

vtkHyperTreeGridOrientedCursor * vtkHyperTreeGridOrientedCursor::Clone ( )

Create a copy of ‘this’.

Postcondition
results_exists:result!=0

◆ Initialize() [1/3]

void vtkHyperTreeGridOrientedCursor::Initialize ( vtkHyperTreeGrid grid,
vtkIdType  treeIndex,
bool  create = false 
)

Initialize cursor at root of given tree index in grid.

◆ Initialize() [2/3]

void vtkHyperTreeGridOrientedCursor::Initialize ( vtkHyperTreeGrid grid,
vtkHyperTree tree,
unsigned int  level,
vtkIdType  index 
)

Initialize cursor at root of given tree index in grid.

◆ Initialize() [3/3]

void vtkHyperTreeGridOrientedCursor::Initialize ( vtkHyperTreeGrid grid,
vtkHyperTree tree,
unsigned int  level,
vtkHyperTreeGridEntry entry 
)

Initialize cursor at root of given tree index in grid.

◆ GetGrid()

vtkHyperTreeGrid * vtkHyperTreeGridOrientedCursor::GetGrid ( )

Set the hyper tree grid to which the cursor is pointing.

◆ HasTree()

bool vtkHyperTreeGridOrientedCursor::HasTree ( ) const

Return if a Tree pointing exist.

◆ GetTree()

vtkHyperTree * vtkHyperTreeGridOrientedCursor::GetTree ( ) const

Set the hyper tree to which the cursor is pointing.

◆ GetVertexId()

vtkIdType vtkHyperTreeGridOrientedCursor::GetVertexId ( )

Return the index of the current vertex in the tree.

◆ GetGlobalNodeIndex()

vtkIdType vtkHyperTreeGridOrientedCursor::GetGlobalNodeIndex ( )

Return the global index (relative to the grid) of the current vertex in the tree.

◆ GetDimension()

unsigned char vtkHyperTreeGridOrientedCursor::GetDimension ( )

Return the dimension of the tree.

Postcondition
positive_result: result>0

◆ GetNumberOfChildren()

unsigned char vtkHyperTreeGridOrientedCursor::GetNumberOfChildren ( )

Return the number of children for each node (non-vertex leaf) of the tree.

Postcondition
positive_number: result>0

◆ SetGlobalIndexStart()

void vtkHyperTreeGridOrientedCursor::SetGlobalIndexStart ( vtkIdType  index)

◆ SetGlobalIndexFromLocal()

void vtkHyperTreeGridOrientedCursor::SetGlobalIndexFromLocal ( vtkIdType  index)

◆ SetMask()

void vtkHyperTreeGridOrientedCursor::SetMask ( bool  state)

Set the blanking mask is empty or not.

Precondition
not_tree: tree

◆ IsMasked()

bool vtkHyperTreeGridOrientedCursor::IsMasked ( )

Determine whether blanking mask is empty or not.

◆ IsLeaf()

bool vtkHyperTreeGridOrientedCursor::IsLeaf ( )

Is the cursor pointing to a leaf?

◆ SubdivideLeaf()

void vtkHyperTreeGridOrientedCursor::SubdivideLeaf ( )

◆ IsRoot()

bool vtkHyperTreeGridOrientedCursor::IsRoot ( )

Is the cursor at tree root?

◆ GetLevel()

unsigned int vtkHyperTreeGridOrientedCursor::GetLevel ( )

Get the level of the tree vertex pointed by the cursor.

◆ ToChild()

void vtkHyperTreeGridOrientedCursor::ToChild ( unsigned char  ichild)

Move the cursor to child ‘child’ of the current vertex.

Precondition
not_tree: HasTree()
not_leaf: !IsLeaf()
valid_child: ichild>=0 && ichild<GetNumberOfChildren()
depth_limiter: GetLevel() <= GetDepthLimiter()

Member Data Documentation

◆ Grid

vtkHyperTreeGrid* vtkHyperTreeGridOrientedCursor::Grid
protected

Reference to the HTG currently processed.

Definition at line 163 of file vtkHyperTreeGridOrientedCursor.h.

◆ Tree

vtkHyperTree* vtkHyperTreeGridOrientedCursor::Tree
protected

Definition at line 165 of file vtkHyperTreeGridOrientedCursor.h.

◆ Level

unsigned int vtkHyperTreeGridOrientedCursor::Level
protected

Definition at line 166 of file vtkHyperTreeGridOrientedCursor.h.

◆ Entry

vtkHyperTreeGridEntry vtkHyperTreeGridOrientedCursor::Entry
protected

Definition at line 169 of file vtkHyperTreeGridOrientedCursor.h.


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