Metadata for a particular type of cell (finite element). More...

#include <vtkCellMetadata.h>

Inheritance diagram for vtkCellMetadata:

Collaboration diagram for vtkCellMetadata:

Public Types
using	CellTypeId = vtkStringToken::Hash

using	DOFType = vtkStringToken

using	MetadataConstructor = std::function< vtkSmartPointer< vtkCellMetadata >(vtkCellGrid *)>

using	ConstructorMap = std::unordered_map< vtkStringToken, MetadataConstructor >

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.

vtkCellMetadata *	NewInstance () const

	vtkInheritanceHierarchyBaseMacro (vtkCellMetadata)

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

CellTypeId	Hash ()
	Return a hash of the cell type.

virtual bool	SetCellGrid (vtkCellGrid *parent)
	Set the vtkCellGrid holding DOF arrays required by this cell.

virtual vtkCellGrid *	GetCellGrid ()
	Return the parent vtkCellGrid that owns this instance (or nullptr).

virtual vtkIdType	GetNumberOfCells ()
	Return the number of cells of this type in the parent cell-grid object.

bool	Query (vtkCellGridQuery *query)
	Respond to a query on cells of this type.

virtual void	ShallowCopy (vtkCellMetadata *vtkNotUsed(other))
	Copy other into this instance (which must be of the same type).

virtual void	DeepCopy (vtkCellMetadata *vtkNotUsed(other))

vtkCellGridResponders *	GetCaches ()
	Return the set of registered responder types.

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.

Static Public Member Functions
static vtkTypeBool	IsTypeOf (const char *type)

static vtkCellMetadata *	SafeDownCast (vtkObjectBase *o)

template<typename Subclass >
static bool	RegisterType ()
	Register a subclass of vtkCellMetadata.

template<typename Subclass >
static vtkSmartPointer< Subclass >	NewInstance (vtkCellGrid *grid=nullptr)

static vtkSmartPointer< vtkCellMetadata >	NewInstance (vtkStringToken className, vtkCellGrid *grid=nullptr)

static std::unordered_set< vtkStringToken >	CellTypes ()

static vtkCellGridResponders *	GetResponders ()
	Return the set of registered responder types.

static void	ClearResponders ()
	Clear all of the registered responders.

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
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCellMetadata ()=default

	~vtkCellMetadata () override

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
static ConstructorMap &	Constructors ()

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

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Protected Attributes
vtkCellGrid *	CellGrid { nullptr }

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

Detailed Description

Metadata for a particular type of cell (finite element).

This is a base class for metadata on cell types held by a vtkCellGrid instance (not for subclasses of vtkCell). A vtkCellGrid holds one instance of a vtkCellMetadata-subclass for each type of cell present in the grid.

This class intentionally provides very little functionality; instead, it is intended to serve as a key or index into a set of registered responder classes which are able respond to queries about cells of this type. This pattern makes it possible to extend VTK with both new cell types and new types of queries for existing cell types.

See also: vtkCellGrid

Examples:: vtkCellMetadata (Examples)

Tests:: vtkCellMetadata (Tests)

Definition at line 52 of file vtkCellMetadata.h.

Member Typedef Documentation

◆ CellTypeId

using vtkCellMetadata::CellTypeId = vtkStringToken::Hash

Definition at line 55 of file vtkCellMetadata.h.

◆ DOFType

using vtkCellMetadata::DOFType = vtkStringToken

Definition at line 56 of file vtkCellMetadata.h.

◆ MetadataConstructor

using vtkCellMetadata::MetadataConstructor = std::function<vtkSmartPointer<vtkCellMetadata>(vtkCellGrid*)>

Definition at line 57 of file vtkCellMetadata.h.

◆ ConstructorMap

using vtkCellMetadata::ConstructorMap = std::unordered_map<vtkStringToken, MetadataConstructor>

Definition at line 58 of file vtkCellMetadata.h.

◆ Superclass

typedef vtkObject vtkCellMetadata::Superclass

Definition at line 60 of file vtkCellMetadata.h.

Constructor & Destructor Documentation

◆ vtkCellMetadata()

vtkCellMetadata::vtkCellMetadata ( )

protecteddefault

◆ ~vtkCellMetadata()

vtkCellMetadata::~vtkCellMetadata ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

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

Reimplemented in vtkDeRhamCell, vtkDGCell, vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCellMetadata::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkDeRhamCell, vtkDGCell, vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ NewInstance() [1/3]

vtkCellMetadata * vtkCellMetadata::NewInstance ( ) const

◆ vtkInheritanceHierarchyBaseMacro()

vtkCellMetadata::vtkInheritanceHierarchyBaseMacro ( vtkCellMetadata )

◆ PrintSelf()

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

Reimplemented in vtkDeRhamCell, vtkDGCell, vtkDGEdge, vtkDGHex, vtkDGPyr, vtkDGQuad, vtkDGTet, vtkDGTri, vtkDGVert, and vtkDGWdg.

◆ RegisterType()

template<typename Subclass >

static bool vtkCellMetadata::RegisterType ( )

inlinestatic

Register a subclass of vtkCellMetadata.

Definition at line 68 of file vtkCellMetadata.h.

◆ NewInstance() [2/3]

template<typename Subclass >

static vtkSmartPointer< Subclass > vtkCellMetadata::NewInstance ( vtkCellGrid * grid = nullptr )

inlinestatic

Definition at line 85 of file vtkCellMetadata.h.

◆ NewInstance() [3/3]

static vtkSmartPointer< vtkCellMetadata > vtkCellMetadata::NewInstance	(	vtkStringToken	className,
		vtkCellGrid *	grid = `nullptr`
	)

static

◆ CellTypes()

static std::unordered_set< vtkStringToken > vtkCellMetadata::CellTypes ( )

static

◆ Hash()

CellTypeId vtkCellMetadata::Hash ( )

inline

Return a hash of the cell type.

WARNING: If you change this method, you must also update vtkCellGrid::AddCellMetadata() and vtkCellGrid::GetCellsOfType().

Definition at line 104 of file vtkCellMetadata.h.

◆ SetCellGrid()

virtual bool vtkCellMetadata::SetCellGrid ( vtkCellGrid * parent )

virtual

Set the vtkCellGrid holding DOF arrays required by this cell.

If the given vtkCellGrid does not have the required degrees of freedom arrays (as provided by GetDOFTypes()), then this method will return false.

If this method returns true, the parent grid will have incremented the reference count of this class instance.

◆ GetCellGrid()

virtual vtkCellGrid * vtkCellMetadata::GetCellGrid ( )

virtual

Return the parent vtkCellGrid that owns this instance (or nullptr).

◆ GetNumberOfCells()

virtual vtkIdType vtkCellMetadata::GetNumberOfCells ( )

inlinevirtual

Return the number of cells of this type in the parent cell-grid object.

Subclasses must override this method.

Reimplemented in vtkDGCell.

Definition at line 123 of file vtkCellMetadata.h.

◆ Query()

bool vtkCellMetadata::Query ( vtkCellGridQuery * query )

Respond to a query on cells of this type.

This returns true on success and false on failure. If no responder has been registered for queries of this type, that is considered a failure.

◆ ShallowCopy()

virtual void vtkCellMetadata::ShallowCopy ( vtkCellMetadata * vtkNotUsedother )

inlinevirtual

Copy other into this instance (which must be of the same type).

These methods exist so subclasses know when they are being copied; the base class has no data to copy, so both ShallowCopy and DeepCopy do nothing.

Definition at line 141 of file vtkCellMetadata.h.

◆ DeepCopy()

virtual void vtkCellMetadata::DeepCopy ( vtkCellMetadata * vtkNotUsedother )

inlinevirtual

Definition at line 142 of file vtkCellMetadata.h.

◆ GetResponders()

static vtkCellGridResponders * vtkCellMetadata::GetResponders ( )

static

Return the set of registered responder types.

◆ ClearResponders()

static void vtkCellMetadata::ClearResponders ( )

static

Clear all of the registered responders.

◆ GetCaches()

vtkCellGridResponders * vtkCellMetadata::GetCaches ( )

Return the set of registered responder types.

This method is not static on purpose; even when VTK is compiled as a set of static libraries, calling this method will always return the proper class-static member. It returns the same value as vtkCellMetadata::GetResponders() but will produce the correct result across static-library boundaries (unlike GetResponders above).

◆ Constructors()

static ConstructorMap & vtkCellMetadata::Constructors ( )

staticprotected

Member Data Documentation

◆ CellGrid

vtkCellGrid* vtkCellMetadata::CellGrid { nullptr }

protected

Definition at line 163 of file vtkCellMetadata.h.

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

Common/DataModel/vtkCellMetadata.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CellTypeId

◆ DOFType

◆ MetadataConstructor

◆ ConstructorMap

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCellMetadata()

◆ ~vtkCellMetadata()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance() [1/3]

◆ vtkInheritanceHierarchyBaseMacro()

◆ PrintSelf()

◆ RegisterType()

◆ NewInstance() [2/3]

◆ NewInstance() [3/3]

◆ CellTypes()

◆ Hash()

◆ SetCellGrid()

◆ GetCellGrid()

◆ GetNumberOfCells()

◆ Query()

◆ ShallowCopy()

◆ DeepCopy()

◆ GetResponders()

◆ ClearResponders()

◆ GetCaches()

◆ Constructors()

Member Data Documentation

◆ CellGrid