VTK  9.4.20241107
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkObjectFactoryCollection Class Reference

maintain a list of object factories More...

#include <vtkObjectFactoryCollection.h>

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

Public Types

typedef vtkCollection Superclass
 
- Public Types inherited from vtkCollection
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.
 
vtkObjectFactoryCollectionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void AddItem (vtkObjectFactory *t)
 Add an ObjectFactory the bottom of the list.
 
vtkObjectFactoryGetNextItem ()
 Get the next ObjectFactory in the list.
 
vtkObjectFactoryGetNextObjectFactory (vtkCollectionSimpleIterator &cookie)
 Reentrant safe way to get an object in a collection.
 
- Public Member Functions inherited from vtkCollection
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkCollectionNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
void AddItem (vtkObject *)
 Add an object to the bottom of the list.
 
void InsertItem (int i, vtkObject *)
 Insert item into the list after the i'th item.
 
void ReplaceItem (int i, vtkObject *)
 Replace the i'th item in the collection with another item.
 
void RemoveItem (int i)
 Remove the i'th item in the list.
 
void RemoveItem (vtkObject *)
 Remove an object from the list.
 
void RemoveAllItems ()
 Remove all objects from the list.
 
int IsItemPresent (vtkObject *a)
 Search for an object and return location in list.
 
int IndexOfFirstOccurence (vtkObject *a)
 Search for an object and return location in list.
 
int GetNumberOfItems ()
 Return the number of objects in the list.
 
void InitTraversal ()
 Initialize the traversal of the collection.
 
void InitTraversal (vtkCollectionSimpleIterator &cookie)
 A reentrant safe way to iterate through a collection.
 
vtkObjectGetNextItemAsObject ()
 Get the next item in the collection.
 
vtkObjectGetItemAsObject (int i)
 Get the i'th item in the collection.
 
vtkObjectGetNextItemAsObject (vtkCollectionSimpleIterator &cookie)
 A reentrant safe way to get the next object as a collection.
 
vtkCollectionIteratorNewIterator ()
 Get an iterator to traverse the objects in this collection.
 
bool UsesGarbageCollector () const override
 Participate in garbage collection.
 
- 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.
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkObjectFactoryCollectionSafeDownCast (vtkObjectBase *o)
 
static vtkObjectFactoryCollectionNew ()
 
- Static Public Member Functions inherited from vtkCollection
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCollectionSafeDownCast (vtkObjectBase *o)
 
static vtkCollectionNew ()
 Construct with empty list.
 
- 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
 
 vtkObjectFactoryCollection ()=default
 
 ~vtkObjectFactoryCollection () override=default
 
- Protected Member Functions inherited from vtkCollection
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCollection ()
 
 ~vtkCollection () override
 
virtual void RemoveElement (vtkCollectionElement *element, vtkCollectionElement *previous)
 
virtual void DeleteElement (vtkCollectionElement *)
 
void ReportReferences (vtkGarbageCollector *collector) 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 &)
 

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 vtkCollection
int NumberOfItems
 
vtkCollectionElementTop
 
vtkCollectionElementBottom
 
vtkCollectionElementCurrent
 
- 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

maintain a list of object factories

vtkObjectFactoryCollection is an object that creates and manipulates ordered lists of objects of type vtkObjectFactory.

See also
vtkCollection vtkObjectFactory

Definition at line 23 of file vtkObjectFactoryCollection.h.

Member Typedef Documentation

◆ Superclass

Definition at line 26 of file vtkObjectFactoryCollection.h.

Constructor & Destructor Documentation

◆ vtkObjectFactoryCollection()

vtkObjectFactoryCollection::vtkObjectFactoryCollection ( )
protecteddefault

◆ ~vtkObjectFactoryCollection()

vtkObjectFactoryCollection::~vtkObjectFactoryCollection ( )
overrideprotecteddefault

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkObjectFactoryCollection::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkCollection.

◆ NewInstance()

vtkObjectFactoryCollection * vtkObjectFactoryCollection::NewInstance ( ) const

◆ New()

static vtkObjectFactoryCollection * vtkObjectFactoryCollection::New ( )
static

◆ PrintSelf()

void vtkObjectFactoryCollection::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 vtkCollection.

◆ AddItem()

void vtkObjectFactoryCollection::AddItem ( vtkObjectFactory t)
inline

Add an ObjectFactory the bottom of the list.

Definition at line 33 of file vtkObjectFactoryCollection.h.

◆ GetNextItem()

vtkObjectFactory * vtkObjectFactoryCollection::GetNextItem ( )
inline

Get the next ObjectFactory in the list.

Return nullptr when the end of the list is reached.

Definition at line 39 of file vtkObjectFactoryCollection.h.

◆ GetNextObjectFactory()

vtkObjectFactory * vtkObjectFactoryCollection::GetNextObjectFactory ( vtkCollectionSimpleIterator cookie)
inline

Reentrant safe way to get an object in a collection.

Just pass the same cookie back and forth.

Definition at line 48 of file vtkObjectFactoryCollection.h.


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