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

helper to import a Cinema database in ParaView More...

#include <vtkSMCinemaDatabaseImporter.h>

Inheritance diagram for vtkSMCinemaDatabaseImporter:
Inheritance graph
[legend]
Collaboration diagram for vtkSMCinemaDatabaseImporter:
Collaboration graph
[legend]

Public Types

typedef vtkSMObject Superclass
 
- Public Types inherited from vtkSMObject
typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
virtual bool SupportsCinema (vtkSMSession *session)
 Returns true if the session supports Cinema databases. More...
 
virtual bool ImportCinema (const std::string &dbase, vtkSMSession *session, vtkSMViewProxy *view=NULL)
 Imports a Cinema database and creates sources as needed for objects in the database. More...
 
- Public Member Functions inherited from vtkSMObject
void PrintSelf (ostream &os, vtkIndent indent) override
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual vtkMTimeType GetMTime ()
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
int HasObserver (unsigned long event)
 
int 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)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 
void PrintRevisions (ostream &)
 

Static Public Member Functions

static vtkSMCinemaDatabaseImporterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMCinemaDatabaseImporterSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkSMObject
static vtkSMObjectNew ()
 
static int IsTypeOf (const char *type)
 
static vtkSMObjectSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 
static vtkObjectBaseNew ()
 

Protected Member Functions

 vtkSMCinemaDatabaseImporter ()
 
 ~vtkSMCinemaDatabaseImporter () override
 
void AddPropertiesForControls (vtkSMSelfGeneratingSourceProxy *reader, const std::string &parametername, const vtkPVCinemaDatabaseInformation *cinfo)
 
- Protected Member Functions inherited from vtkSMObject
 vtkSMObject ()
 
 ~vtkSMObject () override
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
void RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
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
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

helper to import a Cinema database in ParaView

vtkSMCinemaDatabaseImporter can be used by client code to import a Cinema database in ParaView. The importer creates multiple proxies for data-producers in the Cinema database.

Definition at line 37 of file vtkSMCinemaDatabaseImporter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 41 of file vtkSMCinemaDatabaseImporter.h.

Constructor & Destructor Documentation

◆ vtkSMCinemaDatabaseImporter()

vtkSMCinemaDatabaseImporter::vtkSMCinemaDatabaseImporter ( )
protected

◆ ~vtkSMCinemaDatabaseImporter()

vtkSMCinemaDatabaseImporter::~vtkSMCinemaDatabaseImporter ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkSMCinemaDatabaseImporter* vtkSMCinemaDatabaseImporter::New ( )
static

◆ GetClassName()

virtual const char* vtkSMCinemaDatabaseImporter::GetClassName ( )
virtual

Reimplemented from vtkSMObject.

◆ IsTypeOf()

static int vtkSMCinemaDatabaseImporter::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual int vtkSMCinemaDatabaseImporter::IsA ( const char *  type)
virtual

Reimplemented from vtkSMObject.

◆ SafeDownCast()

static vtkSMCinemaDatabaseImporter* vtkSMCinemaDatabaseImporter::SafeDownCast ( vtkObject o)
static

◆ PrintSelf()

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

Reimplemented from vtkObject.

◆ SupportsCinema()

virtual bool vtkSMCinemaDatabaseImporter::SupportsCinema ( vtkSMSession session)
virtual

Returns true if the session supports Cinema databases.

Currently, only builtin sessions and single rank client-server sessions are supported.

Parameters
[in]sessionsession to check for Cinema importing support.
Returns
true if supported, else false.

◆ ImportCinema()

virtual bool vtkSMCinemaDatabaseImporter::ImportCinema ( const std::string dbase,
vtkSMSession session,
vtkSMViewProxy view = NULL 
)
virtual

Imports a Cinema database and creates sources as needed for objects in the database.

Parameters
[in]dbasepath to the Cinema database, typically an info.json file.
[in]sessionsession to load the Cinema database on.
[in]viewif provided, view to show cinema sources by default in.
Returns
true on success, else false.

◆ AddPropertiesForControls()

void vtkSMCinemaDatabaseImporter::AddPropertiesForControls ( vtkSMSelfGeneratingSourceProxy reader,
const std::string parametername,
const vtkPVCinemaDatabaseInformation cinfo 
)
protected

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