VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Friends | List of all members
vtkOverrideInformation Class Reference

Factory object override information. More...

#include <vtkOverrideInformation.h>

Inheritance diagram for vtkOverrideInformation:
[legend]
Collaboration diagram for vtkOverrideInformation:
[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. More...
 
vtkOverrideInformationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Print ObjectFactor to stream. More...
 
const char * GetClassOverrideName ()
 Returns the name of the class being overridden. More...
 
const char * GetClassOverrideWithName ()
 Returns the name of the class that will override the class. More...
 
const char * GetDescription ()
 Return a human readable or GUI displayable description of this override. More...
 
vtkObjectFactoryGetObjectFactory ()
 Return the specific object factory that this override occurs in. More...
 
virtual void SetClassOverrideName (const char *)
 Set the class override name. More...
 
virtual void SetClassOverrideWithName (const char *)
 Set the class override with name. More...
 
virtual void SetDescription (const char *)
 Set the description. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
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. More...
 
int InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. More...
 
virtual void Delete ()
 Delete a VTK object. More...
 
virtual void FastDelete ()
 Delete a reference to this object. More...
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). More...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkOverrideInformationNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkOverrideInformationSafeDownCast (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. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (int val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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. More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
virtual void SetObjectFactory (vtkObjectFactory *)
 
- 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. More...
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Friends

class vtkObjectFactory
 

Additional Inherited Members

- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Factory object override information.

vtkOverrideInformation is used to represent the information about a class which is overridden in a vtkObjectFactory.

Definition at line 32 of file vtkOverrideInformation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 36 of file vtkOverrideInformation.h.

Member Function Documentation

◆ New()

static vtkOverrideInformation* vtkOverrideInformation::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkOverrideInformation::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkOverrideInformation* vtkOverrideInformation::NewInstance ( ) const

◆ PrintSelf()

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

Print ObjectFactor to stream.

Reimplemented from vtkObject.

◆ GetClassOverrideName()

const char* vtkOverrideInformation::GetClassOverrideName ( )
inline

Returns the name of the class being overridden.

For example, if you had a factory that provided an override for vtkVertex, then this function would return "vtkVertex"

Definition at line 47 of file vtkOverrideInformation.h.

◆ GetClassOverrideWithName()

const char* vtkOverrideInformation::GetClassOverrideWithName ( )
inline

Returns the name of the class that will override the class.

For example, if you had a factory that provided an override for vtkVertex called vtkMyVertex, then this would return "vtkMyVertex"

Definition at line 54 of file vtkOverrideInformation.h.

◆ GetDescription()

const char* vtkOverrideInformation::GetDescription ( )
inline

Return a human readable or GUI displayable description of this override.

Definition at line 60 of file vtkOverrideInformation.h.

◆ GetObjectFactory()

vtkObjectFactory* vtkOverrideInformation::GetObjectFactory ( )
inline

Return the specific object factory that this override occurs in.

Definition at line 65 of file vtkOverrideInformation.h.

◆ SetClassOverrideName()

virtual void vtkOverrideInformation::SetClassOverrideName ( const char *  )
virtual

Set the class override name.

◆ SetClassOverrideWithName()

virtual void vtkOverrideInformation::SetClassOverrideWithName ( const char *  )
virtual

Set the class override with name.

◆ SetDescription()

virtual void vtkOverrideInformation::SetDescription ( const char *  )
virtual

Set the description.

◆ SetObjectFactory()

virtual void vtkOverrideInformation::SetObjectFactory ( vtkObjectFactory )
protectedvirtual

Friends And Related Function Documentation

◆ vtkObjectFactory

friend class vtkObjectFactory
friend

Definition at line 93 of file vtkOverrideInformation.h.


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