vtkOverrideInformation Class Reference

Factory object override information. More...

#include <vtkOverrideInformation.h>

Inheritance diagram for vtkOverrideInformation:

Collaboration diagram for vtkOverrideInformation:

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...
vtkOverrideInformation *	NewInstance () 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...
vtkObjectFactory *	GetObjectFactory ()
	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...
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)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
void	RemoveObservers (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
vtkTypeBool	HasObserver (const char *event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...
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	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...
virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkOverrideInformation *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOverrideInformation *	SafeDownCast (vtkObjectBase *o)
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. 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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...
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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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 ()
	These methods allow a command to exclusively grab all events. More...
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
vtkAtomicInt32	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.

Tests:

vtkOverrideInformation (Tests)

Definition at line 35 of file vtkOverrideInformation.h.

Member Typedef Documentation

typedef vtkObject vtkOverrideInformation::Superclass

Definition at line 39 of file vtkOverrideInformation.h.

Member Function Documentation

static vtkOverrideInformation* vtkOverrideInformation::New ( )

static

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

static

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.

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

static

virtual vtkObjectBase* vtkOverrideInformation::NewInstanceInternal ( ) const

protectedvirtual

vtkOverrideInformation* vtkOverrideInformation::NewInstance

(

)

const

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

overridevirtual

Print ObjectFactor to stream.

Reimplemented from vtkObject.

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 50 of file vtkOverrideInformation.h.

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 60 of file vtkOverrideInformation.h.

const char* vtkOverrideInformation::GetDescription ( )

inline

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

Definition at line 69 of file vtkOverrideInformation.h.

vtkObjectFactory* vtkOverrideInformation::GetObjectFactory ( )

inline

Return the specific object factory that this override occurs in.

Definition at line 77 of file vtkOverrideInformation.h.

virtual void vtkOverrideInformation::SetClassOverrideName ( const char *  )

virtual

Set the class override name.

virtual void vtkOverrideInformation::SetClassOverrideWithName ( const char *  )

virtual

Set the class override with name.

virtual void vtkOverrideInformation::SetDescription ( const char *  )

virtual

Set the description.

virtual void vtkOverrideInformation::SetObjectFactory ( vtkObjectFactory *  )

protectedvirtual

Friends And Related Function Documentation

friend class vtkObjectFactory

friend

Definition at line 108 of file vtkOverrideInformation.h.

---

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

• /home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Common/Core/vtkOverrideInformation.h