provides information about a CinemaDatabase. More...

#include <vtkPVCinemaDatabaseInformation.h>

Inheritance diagram for vtkPVCinemaDatabaseInformation:

[legend]

Collaboration diagram for vtkPVCinemaDatabaseInformation:

[legend]

Public Types
typedef vtkPVInformation	Superclass

typedef std::vector< std::string >	VectorOfStrings

typedef VectorOfStrings	PipelineObjectsType

typedef std::map< std::string, VectorOfStrings >	ControlParametersType

typedef std::map< std::string, VectorOfStrings >	PipelineObjectParentsType

typedef std::map< std::string, bool >	PipelineObjectVisibilitiesType

Public Types inherited from vtkPVInformation
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

void	CopyFromObject (vtkObject *) override
	Transfer information about a single object into this object. More...

void	AddInformation (vtkPVInformation *) override
	Merge another information object. More...

void	CopyToStream (vtkClientServerStream *) override
	Manage a serialized version of the information. More...

void	CopyFromStream (const vtkClientServerStream *) override
	Manage a serialized version of the information. More...

const PipelineObjectsType &	GetPipelineObjects () const
	Returns a list of the pipeline objects in the cinema database. More...

const ControlParametersType &	GetControlParameters () const
	Returns a map of control parameters. More...

const VectorOfStrings &	GetControlParameters (const std::string &parameter) const
	Returns the list of control parameter for a specific parameter. More...

const VectorOfStrings &	GetControlParameterValues (const std::string &parameter) const
	Get values for a control parameter. More...

bool	GetPipelineObjectVisibility (const std::string &object) const
	Returns if the pipeline object is visible by default in the database. More...

const PipelineObjectParentsType &	GetPipelineObjectParents () const
	Returns a map with information about parents for each pipeline object. More...

const VectorOfStrings &	GetPipelineObjectParents (const std::string &object) const
	Returns the list of parents for a particular object. More...

Public Member Functions inherited from vtkPVInformation
void	PrintSelf (ostream &os, vtkIndent indent) override

virtual void	CopyParametersToStream (vtkMultiProcessStream &)
	Serialize/Deserialize the parameters that control how/what information is gathered. More...

virtual void	CopyParametersFromStream (vtkMultiProcessStream &)
	Serialize/Deserialize the parameters that control how/what information is gathered. More...

virtual int	GetRootOnly ()
	Set/get whether to gather information only from the root. More...

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)

vtkCommand *	GetCommand (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)

vtkCommand *	GetCommand (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 vtkPVCinemaDatabaseInformation *	New ()

static int	IsTypeOf (const char *type)

static vtkPVCinemaDatabaseInformation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkPVInformation
static int	IsTypeOf (const char *type)

static vtkPVInformation *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

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 vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkPVCinemaDatabaseInformation ()

	~vtkPVCinemaDatabaseInformation () override

void	Reset ()

Protected Member Functions inherited from vtkPVInformation
	vtkPVInformation ()

	~vtkPVInformation () override

virtual void	SetRootOnly (int)

	vtkPVInformation (const vtkPVInformation &)=delete

void	operator= (const vtkPVInformation &)=delete

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 &)

Protected Attributes
PipelineObjectsType	PipelineObjects

ControlParametersType	ControlParameters

ControlParametersType	ControlParameterValues

PipelineObjectParentsType	PipelineObjectParents

PipelineObjectVisibilitiesType	PipelineObjectVisibilities

Protected Attributes inherited from vtkPVInformation
int	RootOnly

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

provides information about a CinemaDatabase.

vtkPVCinemaDatabaseInformation is a vtkPVInformation subclass that can be used to gather information about a vtkCinemaDatabase instance. It is a RootOnly information object, hence information is only gathered from the root node in multi-rank configurations. vtkSMCinemaDatabaseImporter uses this information object to collect what we know about pipelines objects and their parameters. vtkSMCinemaDatabaseImporter can then create proxies for each of the pipeline objects and add dynamic properties to match the control parameters available for each pipeline object in the database.

Definition at line 38 of file vtkPVCinemaDatabaseInformation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPVInformation vtkPVCinemaDatabaseInformation::Superclass

Definition at line 42 of file vtkPVCinemaDatabaseInformation.h.

◆ VectorOfStrings

typedef std::vector<std::string> vtkPVCinemaDatabaseInformation::VectorOfStrings

Definition at line 50 of file vtkPVCinemaDatabaseInformation.h.

◆ PipelineObjectsType

typedef VectorOfStrings vtkPVCinemaDatabaseInformation::PipelineObjectsType

Definition at line 51 of file vtkPVCinemaDatabaseInformation.h.

◆ ControlParametersType

typedef std::map<std::string, VectorOfStrings> vtkPVCinemaDatabaseInformation::ControlParametersType

Definition at line 52 of file vtkPVCinemaDatabaseInformation.h.

◆ PipelineObjectParentsType

typedef std::map<std::string, VectorOfStrings> vtkPVCinemaDatabaseInformation::PipelineObjectParentsType

Definition at line 53 of file vtkPVCinemaDatabaseInformation.h.

◆ PipelineObjectVisibilitiesType

typedef std::map<std::string, bool> vtkPVCinemaDatabaseInformation::PipelineObjectVisibilitiesType

Definition at line 54 of file vtkPVCinemaDatabaseInformation.h.

Constructor & Destructor Documentation

◆ vtkPVCinemaDatabaseInformation()

vtkPVCinemaDatabaseInformation::vtkPVCinemaDatabaseInformation ( )

protected

◆ ~vtkPVCinemaDatabaseInformation()

vtkPVCinemaDatabaseInformation::~vtkPVCinemaDatabaseInformation ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVCinemaDatabaseInformation* vtkPVCinemaDatabaseInformation::New ( )

static

◆ GetClassName()

virtual const char* vtkPVCinemaDatabaseInformation::GetClassName ( )

virtual

Reimplemented from vtkPVInformation.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkPVInformation.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ CopyFromObject()

void vtkPVCinemaDatabaseInformation::CopyFromObject ( vtkObject * )

overridevirtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

◆ AddInformation()

void vtkPVCinemaDatabaseInformation::AddInformation ( vtkPVInformation * )

overridevirtual

Merge another information object.

Reimplemented from vtkPVInformation.

◆ CopyToStream()

void vtkPVCinemaDatabaseInformation::CopyToStream ( vtkClientServerStream * )

overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

◆ CopyFromStream()

void vtkPVCinemaDatabaseInformation::CopyFromStream ( const vtkClientServerStream * )

overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

◆ GetPipelineObjects()

const PipelineObjectsType& vtkPVCinemaDatabaseInformation::GetPipelineObjects ( ) const

inline

Returns a list of the pipeline objects in the cinema database.

Definition at line 59 of file vtkPVCinemaDatabaseInformation.h.

◆ GetControlParameters() [1/2]

const ControlParametersType& vtkPVCinemaDatabaseInformation::GetControlParameters ( ) const

inline

Returns a map of control parameters.

Definition at line 64 of file vtkPVCinemaDatabaseInformation.h.

◆ GetControlParameters() [2/2]

const VectorOfStrings& vtkPVCinemaDatabaseInformation::GetControlParameters ( const std::string & parameter ) const

Returns the list of control parameter for a specific parameter.

◆ GetControlParameterValues()

const VectorOfStrings& vtkPVCinemaDatabaseInformation::GetControlParameterValues ( const std::string & parameter ) const

Get values for a control parameter.

For convenience they are returned as strings.

◆ GetPipelineObjectVisibility()

bool vtkPVCinemaDatabaseInformation::GetPipelineObjectVisibility ( const std::string & object ) const

Returns if the pipeline object is visible by default in the database.

◆ GetPipelineObjectParents() [1/2]

const PipelineObjectParentsType& vtkPVCinemaDatabaseInformation::GetPipelineObjectParents ( ) const

inline

Returns a map with information about parents for each pipeline object.

Useful to setup pipeline connections.

Returns: a map where key is the name of the pipeline object and value is a vector of names of pipeline objects that are its parents i.e. upstream or inputs.

Definition at line 88 of file vtkPVCinemaDatabaseInformation.h.

◆ GetPipelineObjectParents() [2/2]

const VectorOfStrings& vtkPVCinemaDatabaseInformation::GetPipelineObjectParents ( const std::string & object ) const

Returns the list of parents for a particular object.

◆ Reset()

void vtkPVCinemaDatabaseInformation::Reset ( )

protected

Member Data Documentation

◆ PipelineObjects

PipelineObjectsType vtkPVCinemaDatabaseInformation::PipelineObjects

protected

Definition at line 104 of file vtkPVCinemaDatabaseInformation.h.

◆ ControlParameters

ControlParametersType vtkPVCinemaDatabaseInformation::ControlParameters

protected

Definition at line 105 of file vtkPVCinemaDatabaseInformation.h.

◆ ControlParameterValues

ControlParametersType vtkPVCinemaDatabaseInformation::ControlParameterValues

protected

Definition at line 106 of file vtkPVCinemaDatabaseInformation.h.

◆ PipelineObjectParents

PipelineObjectParentsType vtkPVCinemaDatabaseInformation::PipelineObjectParents

protected

Definition at line 107 of file vtkPVCinemaDatabaseInformation.h.

◆ PipelineObjectVisibilities

PipelineObjectVisibilitiesType vtkPVCinemaDatabaseInformation::PipelineObjectVisibilities

protected

Definition at line 108 of file vtkPVCinemaDatabaseInformation.h.

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

/home/kitware/dashboards/buildbot/paraview_release-vall-linux-shared-release_adios2_doc_extdeps_gui_mpi_python3/source/Remoting/Cinema/vtkPVCinemaDatabaseInformation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

◆ VectorOfStrings

◆ PipelineObjectsType

◆ ControlParametersType

◆ PipelineObjectParentsType

◆ PipelineObjectVisibilitiesType

Constructor & Destructor Documentation

◆ vtkPVCinemaDatabaseInformation()

◆ ~vtkPVCinemaDatabaseInformation()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ CopyFromObject()

◆ AddInformation()

◆ CopyToStream()

◆ CopyFromStream()

◆ GetPipelineObjects()

◆ GetControlParameters() [1/2]

◆ GetControlParameters() [2/2]

◆ GetControlParameterValues()

◆ GetPipelineObjectVisibility()

◆ GetPipelineObjectParents() [1/2]

◆ GetPipelineObjectParents() [2/2]

◆ Reset()

Member Data Documentation

◆ PipelineObjects

◆ ControlParameters

◆ ControlParameterValues

◆ PipelineObjectParents

◆ PipelineObjectVisibilities