VTK  9.7.20260922
vtkCellGridChangeBasis::Query Class Reference

#include <vtkCellGridChangeBasis.h>

Detailed Description

A cell-grid query for changing cell-attribute basis functions.

Definition at line 71 of file vtkCellGridChangeBasis.h.

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

Public Member Functions

 Query ()
 Construct a query.
 ~Query () override
vtkMTimeType GetMTime () override
 Return the MTime also considering the cell-attribute.
vtkDataArrayCreateNewDataArray (vtkDataArray *input) const
 A convenience method for responders to create arrays at the requested output precision given an input array.
std::map< vtkDataArray *, vtkSmartPointer< vtkDataArray > > & GetSharedOutputs ()
 Output arrays holding shared degrees of freedom, keyed by the input array each one replaces.
bool Initialize () override
 Forget the arrays from any previous invocation.
virtual void SetCellAttribute (vtkCellAttribute *)
 Specify the cell-attribute to be converted.
virtual vtkCellAttributeGetCellAttribute ()
 Specify the cell-attribute to be converted.
 vtkSetStringTokenMacro (SourceFunctionSpace)
 Set/get the function space that should be converted.
 vtkGetStringTokenMacro (SourceFunctionSpace)
 Set/get the function space that should be converted.
 vtkSetStringTokenMacro (SourceBasis)
 Set/get the basis that should be converted.
 vtkGetStringTokenMacro (SourceBasis)
 Set/get the basis that should be converted.
virtual void SetSourceOrder (int)
 Set/get the order that should be converted.
virtual int GetSourceOrder ()
 Set/get the order that should be converted.
 vtkSetStringTokenMacro (TargetFunctionSpace)
 Set/get the destination function space.
 vtkGetStringTokenMacro (TargetFunctionSpace)
 Set/get the destination function space.
 vtkSetStringTokenMacro (TargetBasis)
 Set/get the destination basis.
 vtkGetStringTokenMacro (TargetBasis)
 Set/get the destination basis.
virtual void SetTargetOrder (int)
 Set/get the order that should be converted.
virtual int GetTargetOrder ()
 Set/get the order that should be converted.
Public Member Functions inherited from vtkCellGridQuery
vtkCellGridQueryNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
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.
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 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

vtkCellAttributeCellAttribute { nullptr }
vtkStringToken SourceFunctionSpace
vtkStringToken SourceBasis
int SourceOrder { -1 }
vtkStringToken TargetFunctionSpace
vtkStringToken TargetBasis
int TargetOrder { -1 }
int OutputPointsPrecision { vtkAlgorithm::DesiredOutputPrecision::DEFAULT_PRECISION }
std::map< vtkDataArray *, vtkSmartPointer< vtkDataArray > > SharedOutputs
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
typedef vtkCellGridQuery Superclass
 Standard methods for instantiation, obtaining type information, and printing.
static QueryNew ()
 Standard methods for instantiation, obtaining type information, and printing.
static vtkTypeBool IsTypeOf (const char *type)
 Standard methods for instantiation, obtaining type information, and printing.
static vtkCellGridChangeBasis::QuerySafeDownCast (vtkObjectBase *o)
 Standard methods for instantiation, obtaining type information, and printing.
virtual vtkTypeBool IsA (const char *type)
 Standard methods for instantiation, obtaining type information, and printing.
vtkCellGridChangeBasis::QueryNewInstance () const
 Standard methods for instantiation, obtaining type information, and printing.
void PrintSelf (ostream &os, vtkIndent indent) override
 Standard methods for instantiation, obtaining type information, and printing.
virtual vtkObjectBaseNewInstanceInternal () const
 Standard methods for instantiation, obtaining type information, and printing.

Additional Inherited Members

Public Types inherited from vtkCellGridQuery
typedef vtkObject Superclass
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 inherited from vtkCellGridQuery
 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 ReportReferences (vtkGarbageCollector *)
 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 ()

Member Typedef Documentation

◆ Superclass

Standard methods for instantiation, obtaining type information, and printing.

Definition at line 80 of file vtkCellGridChangeBasis.h.

Constructor & Destructor Documentation

◆ Query()

vtkCellGridChangeBasis::Query::Query ( )

Construct a query.

◆ ~Query()

vtkCellGridChangeBasis::Query::~Query ( )
override

Member Function Documentation

◆ New()

Query * vtkCellGridChangeBasis::Query::New ( )
static

Standard methods for instantiation, obtaining type information, and printing.

◆ IsTypeOf()

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

Standard methods for instantiation, obtaining type information, and printing.

◆ IsA()

virtual vtkTypeBool vtkCellGridChangeBasis::Query::IsA ( const char * type)
virtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkCellGridQuery.

◆ SafeDownCast()

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

Standard methods for instantiation, obtaining type information, and printing.

◆ NewInstanceInternal()

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

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkCellGridQuery.

◆ NewInstance()

vtkCellGridChangeBasis::Query * vtkCellGridChangeBasis::Query::NewInstance ( ) const

Standard methods for instantiation, obtaining type information, and printing.

◆ PrintSelf()

void vtkCellGridChangeBasis::Query::PrintSelf ( ostream & os,
vtkIndent indent )
overridevirtual

Standard methods for instantiation, obtaining type information, and printing.

Reimplemented from vtkObjectBase.

◆ GetMTime()

vtkMTimeType vtkCellGridChangeBasis::Query::GetMTime ( )
overridevirtual

Return the MTime also considering the cell-attribute.

Reimplemented from vtkObject.

◆ SetCellAttribute()

virtual void vtkCellGridChangeBasis::Query::SetCellAttribute ( vtkCellAttribute * )
virtual

Specify the cell-attribute to be converted.

◆ GetCellAttribute()

virtual vtkCellAttribute * vtkCellGridChangeBasis::Query::GetCellAttribute ( )
virtual

Specify the cell-attribute to be converted.

◆ vtkSetStringTokenMacro() [1/4]

vtkCellGridChangeBasis::Query::vtkSetStringTokenMacro ( SourceFunctionSpace )

Set/get the function space that should be converted.

◆ vtkGetStringTokenMacro() [1/4]

vtkCellGridChangeBasis::Query::vtkGetStringTokenMacro ( SourceFunctionSpace )

Set/get the function space that should be converted.

◆ vtkSetStringTokenMacro() [2/4]

vtkCellGridChangeBasis::Query::vtkSetStringTokenMacro ( SourceBasis )

Set/get the basis that should be converted.

◆ vtkGetStringTokenMacro() [2/4]

vtkCellGridChangeBasis::Query::vtkGetStringTokenMacro ( SourceBasis )

Set/get the basis that should be converted.

◆ SetSourceOrder()

virtual void vtkCellGridChangeBasis::Query::SetSourceOrder ( int )
virtual

Set/get the order that should be converted.

◆ GetSourceOrder()

virtual int vtkCellGridChangeBasis::Query::GetSourceOrder ( )
virtual

Set/get the order that should be converted.

◆ vtkSetStringTokenMacro() [3/4]

vtkCellGridChangeBasis::Query::vtkSetStringTokenMacro ( TargetFunctionSpace )

Set/get the destination function space.

◆ vtkGetStringTokenMacro() [3/4]

vtkCellGridChangeBasis::Query::vtkGetStringTokenMacro ( TargetFunctionSpace )

Set/get the destination function space.

◆ vtkSetStringTokenMacro() [4/4]

vtkCellGridChangeBasis::Query::vtkSetStringTokenMacro ( TargetBasis )

Set/get the destination basis.

◆ vtkGetStringTokenMacro() [4/4]

vtkCellGridChangeBasis::Query::vtkGetStringTokenMacro ( TargetBasis )

Set/get the destination basis.

◆ SetTargetOrder()

virtual void vtkCellGridChangeBasis::Query::SetTargetOrder ( int )
virtual

Set/get the order that should be converted.

◆ GetTargetOrder()

virtual int vtkCellGridChangeBasis::Query::GetTargetOrder ( )
virtual

Set/get the order that should be converted.

◆ CreateNewDataArray()

vtkDataArray * vtkCellGridChangeBasis::Query::CreateNewDataArray ( vtkDataArray * input) const

A convenience method for responders to create arrays at the requested output precision given an input array.

◆ GetSharedOutputs()

std::map< vtkDataArray *, vtkSmartPointer< vtkDataArray > > & vtkCellGridChangeBasis::Query::GetSharedOutputs ( )
inline

Output arrays holding shared degrees of freedom, keyed by the input array each one replaces.

A responder handles one cell type at a time, but several cell types may share one group of degrees of freedom. They must then write into a single output array, so the first responder to need one records it here and the rest reuse it.

Definition at line 160 of file vtkCellGridChangeBasis.h.

◆ Initialize()

bool vtkCellGridChangeBasis::Query::Initialize ( )
overridevirtual

Forget the arrays from any previous invocation.

Reimplemented from vtkCellGridQuery.

Member Data Documentation

◆ CellAttribute

vtkCellAttribute* vtkCellGridChangeBasis::Query::CellAttribute { nullptr }
protected

Definition at line 169 of file vtkCellGridChangeBasis.h.

◆ SourceFunctionSpace

vtkStringToken vtkCellGridChangeBasis::Query::SourceFunctionSpace
protected

Definition at line 170 of file vtkCellGridChangeBasis.h.

◆ SourceBasis

vtkStringToken vtkCellGridChangeBasis::Query::SourceBasis
protected

Definition at line 171 of file vtkCellGridChangeBasis.h.

◆ SourceOrder

int vtkCellGridChangeBasis::Query::SourceOrder { -1 }
protected

Definition at line 172 of file vtkCellGridChangeBasis.h.

◆ TargetFunctionSpace

vtkStringToken vtkCellGridChangeBasis::Query::TargetFunctionSpace
protected

Definition at line 173 of file vtkCellGridChangeBasis.h.

◆ TargetBasis

vtkStringToken vtkCellGridChangeBasis::Query::TargetBasis
protected

Definition at line 174 of file vtkCellGridChangeBasis.h.

◆ TargetOrder

int vtkCellGridChangeBasis::Query::TargetOrder { -1 }
protected

Definition at line 175 of file vtkCellGridChangeBasis.h.

◆ OutputPointsPrecision

int vtkCellGridChangeBasis::Query::OutputPointsPrecision { vtkAlgorithm::DesiredOutputPrecision::DEFAULT_PRECISION }
protected

Definition at line 176 of file vtkCellGridChangeBasis.h.

◆ SharedOutputs

std::map<vtkDataArray*, vtkSmartPointer<vtkDataArray> > vtkCellGridChangeBasis::Query::SharedOutputs
protected

Definition at line 177 of file vtkCellGridChangeBasis.h.


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