Abstract class for field definition used by vtkHyperTreeGridGenerateFields. More...

#include <vtkHyperTreeGridGenerateFieldStrategy.h>

Inheritance diagram for vtkHyperTreeGridGenerateFieldStrategy:

Collaboration diagram for vtkHyperTreeGridGenerateFieldStrategy:

Classes
struct	Field

Public Member Functions
	vtkHyperTreeGridGenerateFieldStrategy ()=default

	vtkAbstractTypeMacro (vtkHyperTreeGridGenerateFieldStrategy, vtkObject)

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.


virtual void	Initialize (vtkHyperTreeGrid *vtkMaybeUnused(inputHTG))
	Reimplement to initialize internal structures based on the given input HTG.

virtual bool	Initialize (std::unordered_map< std::string, Field >)
	Reimplement to initialize internal structures based on the given input HTG.


virtual void	Compute (vtkHyperTreeGridNonOrientedGeometryCursor *)
	Reimplement to compute the data for the current cell.

virtual void	Compute (vtkHyperTreeGridNonOrientedGeometryCursor , vtkCellData , std::unordered_map< std::string, Field >)
	Reimplement to compute the data for the current cell.


virtual vtkDataArray *	GetAndFinalizeArray ()=0
	Reimplement to build the output array from internally stored values.


vtkDataObject::AttributeTypes	GetArrayType ()
	Get/Set type of the data array.

void	SetArrayType (vtkDataObject::AttributeTypes arrayType)
	Get/Set type of the data array.


std::string	GetArrayName ()
	Get/Set the name of the array containing the data.

void	SetArrayName (std::string arrayName)
	Get/Set the name of the array containing the data.

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.

Protected Attributes
std::string	ArrayName

vtkDataObject::AttributeTypes	ArrayType = vtkDataObject::AttributeTypes::CELL

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 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 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 &)

Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Abstract class for field definition used by vtkHyperTreeGridGenerateFields.

This is a class used by vtkHyperTreeGridGenerateFields to define the methods that need to be overridden in order to compute new fields for a HTG.

Definition at line 22 of file vtkHyperTreeGridGenerateFieldStrategy.h.

Constructor & Destructor Documentation

◆ vtkHyperTreeGridGenerateFieldStrategy()

vtkHyperTreeGridGenerateFieldStrategy::vtkHyperTreeGridGenerateFieldStrategy ( )

default

Member Function Documentation

◆ vtkAbstractTypeMacro()

vtkHyperTreeGridGenerateFieldStrategy::vtkAbstractTypeMacro	(	vtkHyperTreeGridGenerateFieldStrategy	,
		vtkObject
	)

◆ PrintSelf()

void vtkHyperTreeGridGenerateFieldStrategy::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

inlineoverridevirtual

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.

Reimplemented in vtkHyperTreeGridTotalVisibleVolumeStrategy, and vtkHyperTreeGridValidCellStrategy.

Definition at line 36 of file vtkHyperTreeGridGenerateFieldStrategy.h.

◆ Initialize() [1/2]

virtual void vtkHyperTreeGridGenerateFieldStrategy::Initialize ( vtkHyperTreeGrid * vtkMaybeUnusedinputHTG )

inlinevirtual

Reimplement to initialize internal structures based on the given input HTG.

Only one of these methods should be reimplemented:

If the strategy creates a cell data array, use Initialize with a void return type
If the strategy creates a field data array, use Initialize with a bool return type

Reimplemented in vtkHyperTreeGridCellCenterStrategy, vtkHyperTreeGridCellSizeStrategy, vtkHyperTreeGridTotalVisibleVolumeStrategy, and vtkHyperTreeGridValidCellStrategy.

Definition at line 52 of file vtkHyperTreeGridGenerateFieldStrategy.h.

◆ Initialize() [2/2]

virtual bool vtkHyperTreeGridGenerateFieldStrategy::Initialize ( std::unordered_map< std::string, Field > )

inlinevirtual

Reimplement to initialize internal structures based on the given input HTG.

Only one of these methods should be reimplemented:

If the strategy creates a cell data array, use Initialize with a void return type
If the strategy creates a field data array, use Initialize with a bool return type

Reimplemented in vtkHyperTreeGridTotalVisibleVolumeStrategy, vtkHyperTreeGridCellCenterStrategy, vtkHyperTreeGridCellSizeStrategy, vtkHyperTreeGridTotalVisibleVolumeStrategy, and vtkHyperTreeGridValidCellStrategy.

Definition at line 53 of file vtkHyperTreeGridGenerateFieldStrategy.h.

◆ Compute() [1/2]

virtual void vtkHyperTreeGridGenerateFieldStrategy::Compute ( vtkHyperTreeGridNonOrientedGeometryCursor * )

inlinevirtual

Reimplement to compute the data for the current cell.

Only one of these methods should be reimplemented:

If the strategy creates a cell data array, use Compute with a single parameter
If the strategy creates a field data array, use Compute with the extra parameters (they provide the result of the previously computed cell data).

Reimplemented in vtkHyperTreeGridCellCenterStrategy, vtkHyperTreeGridCellSizeStrategy, vtkHyperTreeGridTotalVisibleVolumeStrategy, vtkHyperTreeGridValidCellStrategy, vtkHyperTreeGridCellCenterStrategy, vtkHyperTreeGridCellSizeStrategy, and vtkHyperTreeGridValidCellStrategy.

Definition at line 64 of file vtkHyperTreeGridGenerateFieldStrategy.h.

◆ Compute() [2/2]

virtual void vtkHyperTreeGridGenerateFieldStrategy::Compute	(	vtkHyperTreeGridNonOrientedGeometryCursor *	,
		vtkCellData *	,
		std::unordered_map< std::string, Field >
	)

inlinevirtual

Reimplement to compute the data for the current cell.

Only one of these methods should be reimplemented:

If the strategy creates a cell data array, use Compute with a single parameter
If the strategy creates a field data array, use Compute with the extra parameters (they provide the result of the previously computed cell data).

Reimplemented in vtkHyperTreeGridCellCenterStrategy, vtkHyperTreeGridCellSizeStrategy, vtkHyperTreeGridTotalVisibleVolumeStrategy, vtkHyperTreeGridValidCellStrategy, and vtkHyperTreeGridTotalVisibleVolumeStrategy.

Definition at line 65 of file vtkHyperTreeGridGenerateFieldStrategy.h.