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

A version of vtkArchiver that can be implemented in Python. More...

#include <vtkPythonArchiver.h>

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

Public Types

typedef vtkArchiver Superclass
 
- Public Types inherited from vtkArchiver
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...
 
vtkPythonArchiverNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetPythonObject (PyObject *obj)
 Specify the Python object to use to perform the archiving. More...
 
void OpenArchive () override
 Open the arhive for writing. More...
 
void CloseArchive () override
 Close the arhive. More...
 
void InsertIntoArchive (const std::string &relativePath, const char *data, std::size_t size) override
 Insert data of size size into the archive at relativePath. More...
 
bool Contains (const std::string &relativePath) override
 Checks if relativePath represents an entry in the archive. More...
 
- Public Member Functions inherited from vtkArchiver
vtkArchiverNewInstance () const
 
virtual char * GetArchiveName ()
 Specify the name of the archive to generate. More...
 
virtual void SetArchiveName (const char *)
 
- 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 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). 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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 

Static Public Member Functions

static vtkPythonArchiverNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPythonArchiverSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkArchiver
static vtkArchiverNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkArchiverSafeDownCast (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 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). More...
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPythonArchiver ()
 
 ~vtkPythonArchiver () override
 
- Protected Member Functions inherited from vtkArchiver
 vtkArchiver ()
 
 ~vtkArchiver () 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 ReportReferences (vtkGarbageCollector *)
 
 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 vtkArchiver
char * ArchiveName
 
- 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

A version of vtkArchiver that can be implemented in Python.

vtkPythonArchiver is an implementation of vtkArchiver that calls a Python object to do the actual work. It defers the following methods to Python:

Python signature of these methods is as follows:

See also
vtkPythonArchiver

Definition at line 48 of file vtkPythonArchiver.h.

Member Typedef Documentation

◆ Superclass

Definition at line 52 of file vtkPythonArchiver.h.

Constructor & Destructor Documentation

◆ vtkPythonArchiver()

vtkPythonArchiver::vtkPythonArchiver ( )
protected

◆ ~vtkPythonArchiver()

vtkPythonArchiver::~vtkPythonArchiver ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPythonArchiver* vtkPythonArchiver::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPythonArchiver::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 vtkArchiver.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPythonArchiver::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkArchiver.

◆ NewInstance()

vtkPythonArchiver* vtkPythonArchiver::NewInstance ( ) const

◆ PrintSelf()

void vtkPythonArchiver::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 vtkArchiver.

◆ SetPythonObject()

void vtkPythonArchiver::SetPythonObject ( PyObject obj)

Specify the Python object to use to perform the archiving.

A reference will be taken on the object.

◆ OpenArchive()

void vtkPythonArchiver::OpenArchive ( )
overridevirtual

Open the arhive for writing.

Reimplemented from vtkArchiver.

◆ CloseArchive()

void vtkPythonArchiver::CloseArchive ( )
overridevirtual

Close the arhive.

Reimplemented from vtkArchiver.

◆ InsertIntoArchive()

void vtkPythonArchiver::InsertIntoArchive ( const std::string &  relativePath,
const char *  data,
std::size_t  size 
)
overridevirtual

Insert data of size size into the archive at relativePath.

Reimplemented from vtkArchiver.

◆ Contains()

bool vtkPythonArchiver::Contains ( const std::string &  relativePath)
overridevirtual

Checks if relativePath represents an entry in the archive.

Reimplemented from vtkArchiver.


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