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

Versioning class for vtk. More...

#include <vtkVersion.h>

Inheritance diagram for vtkVersion:
[legend]
Collaboration diagram for vtkVersion:
[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...
 
vtkVersionNewInstance () const
 
- 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 PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. 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 vtkVersionNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkVersionSafeDownCast (vtkObjectBase *o)
 
static const char * GetVTKVersion ()
 Return the version of vtk this object is a part of. More...
 
static int GetVTKMajorVersion ()
 
static int GetVTKMinorVersion ()
 
static int GetVTKBuildVersion ()
 
static const char * GetVTKSourceVersion ()
 
- 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
 
 vtkVersion ()
 
 ~vtkVersion () 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. 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 &)
 

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

Versioning class for vtk.

Holds methods for defining/determining the current vtk version (major, minor, build).

Warning
This file will change frequently to update the VTKSourceVersion which timestamps a particular source release.
Examples:
vtkVersion (Examples)
Tests:
vtkVersion (Tests)

Definition at line 46 of file vtkVersion.h.

Member Typedef Documentation

◆ Superclass

Definition at line 50 of file vtkVersion.h.

Constructor & Destructor Documentation

◆ vtkVersion()

vtkVersion::vtkVersion ( )
inlineprotected

Definition at line 64 of file vtkVersion.h.

◆ ~vtkVersion()

vtkVersion::~vtkVersion ( )
inlineoverrideprotected

Definition at line 65 of file vtkVersion.h.

Member Function Documentation

◆ New()

static vtkVersion* vtkVersion::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkVersion::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkVersion* vtkVersion::NewInstance ( ) const

◆ GetVTKVersion()

static const char* vtkVersion::GetVTKVersion ( )
inlinestatic

Return the version of vtk this object is a part of.

A variety of methods are included. GetVTKSourceVersion returns a string with an identifier which timestamps a particular source tree.

Definition at line 57 of file vtkVersion.h.

◆ GetVTKMajorVersion()

static int vtkVersion::GetVTKMajorVersion ( )
inlinestatic

Definition at line 58 of file vtkVersion.h.

◆ GetVTKMinorVersion()

static int vtkVersion::GetVTKMinorVersion ( )
inlinestatic

Definition at line 59 of file vtkVersion.h.

◆ GetVTKBuildVersion()

static int vtkVersion::GetVTKBuildVersion ( )
inlinestatic

Definition at line 60 of file vtkVersion.h.

◆ GetVTKSourceVersion()

static const char* vtkVersion::GetVTKSourceVersion ( )
inlinestatic

Definition at line 61 of file vtkVersion.h.


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