Light object for holding composite data information. More...

#include <vtkPVCompositeDataInformation.h>

Inheritance diagram for vtkPVCompositeDataInformation:

Collaboration diagram for vtkPVCompositeDataInformation:

[legend]

Public Types
typedef vtkPVInformation	Superclass

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...

virtual void	Initialize ()
	Clears all internal data structures. More...

unsigned int	GetNumberOfChildren ()
	Returns the number of children. More...

vtkPVDataInformation *	GetDataInformation (unsigned int idx)
	Returns the information for the data object at the given index. More...

const char *	GetName (unsigned int idx)
	Return the name of the child node at the given index, if any. 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...


virtual int	GetDataIsMultiPiece ()
	Get/Set if the data is multipiece. More...


virtual int	GetDataIsComposite ()
	Returns if the dataset is a composite dataset. More...


virtual unsigned int	GetNumberOfAMRLevels ()
	Returns the number of levels in the AMR dataset. 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 vtkPVCompositeDataInformation *	New ()

static int	IsTypeOf (const char *type)

static vtkPVCompositeDataInformation *	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
	vtkPVCompositeDataInformation ()

	~vtkPVCompositeDataInformation () override

void	CopyFromAMR (vtkUniformGridAMR *amr)
	Copy information from an amr dataset. More...

virtual void	SetNumberOfPieces (unsigned int)

vtkPVDataInformation *	GetDataInformationForCompositeIndex (int *index)

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
int	DataIsMultiPiece

int	DataIsComposite

unsigned int	FlatIndexMax

unsigned int	NumberOfPieces

unsigned int	NumberOfAMRLevels

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

Friends
class	vtkPVDataInformation

Detailed Description

Light object for holding composite data information.

vtkPVCompositeDataInformation is used to copy the meta information of a composite dataset from server to client. It holds a vtkPVDataInformation for each block of the composite dataset.

See also: vtkHierarchicalBoxDataSet vtkPVDataInformation

Definition at line 37 of file vtkPVCompositeDataInformation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPVInformation vtkPVCompositeDataInformation::Superclass

Definition at line 41 of file vtkPVCompositeDataInformation.h.

Constructor & Destructor Documentation

◆ vtkPVCompositeDataInformation()

vtkPVCompositeDataInformation::vtkPVCompositeDataInformation ( )

protected

◆ ~vtkPVCompositeDataInformation()

vtkPVCompositeDataInformation::~vtkPVCompositeDataInformation ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPVCompositeDataInformation* vtkPVCompositeDataInformation::New ( )

static

◆ GetClassName()

virtual const char* vtkPVCompositeDataInformation::GetClassName ( )

virtual

Reimplemented from vtkPVInformation.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkPVInformation.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

◆ CopyFromObject()

void vtkPVCompositeDataInformation::CopyFromObject ( vtkObject * )

overridevirtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

◆ AddInformation()

void vtkPVCompositeDataInformation::AddInformation ( vtkPVInformation * )

overridevirtual

Merge another information object.

Reimplemented from vtkPVInformation.

◆ CopyToStream()

void vtkPVCompositeDataInformation::CopyToStream ( vtkClientServerStream * )

overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

◆ CopyFromStream()

void vtkPVCompositeDataInformation::CopyFromStream ( const vtkClientServerStream * )

overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

◆ Initialize()

virtual void vtkPVCompositeDataInformation::Initialize ( )

virtual

Clears all internal data structures.

◆ GetNumberOfChildren()

unsigned int vtkPVCompositeDataInformation::GetNumberOfChildren ( )

Returns the number of children.

◆ GetDataInformation()

vtkPVDataInformation* vtkPVCompositeDataInformation::GetDataInformation ( unsigned int idx )

Returns the information for the data object at the given index.

If the child is a composite dataset itself, then the return vtkPVDataInformation will have the CompositeDataInformation set appropriately.

◆ GetName()

const char* vtkPVCompositeDataInformation::GetName ( unsigned int idx )

Return the name of the child node at the given index, if any.

This is the value for the key vtkCompositeDataSet::NAME() in the meta-data associated with the node.

◆ GetDataIsMultiPiece()

virtual int vtkPVCompositeDataInformation::GetDataIsMultiPiece ( )

virtual

Get/Set if the data is multipiece.

If so, then GetDataInformation() will always return NULL. For vtkMultiblockDataSet, we don't collect information about individual pieces. One can however, query the number of pieces by using GetNumberOfChildren().

◆ GetDataIsComposite()

virtual int vtkPVCompositeDataInformation::GetDataIsComposite ( )

virtual

Returns if the dataset is a composite dataset.

◆ GetNumberOfAMRLevels()

virtual unsigned int vtkPVCompositeDataInformation::GetNumberOfAMRLevels ( )

virtual

Returns the number of levels in the AMR dataset.

Only valid for vtkUniformGridAMR datasets.

◆ CopyFromAMR()

void vtkPVCompositeDataInformation::CopyFromAMR ( vtkUniformGridAMR * amr )

protected

Copy information from an amr dataset.

◆ SetNumberOfPieces()

virtual void vtkPVCompositeDataInformation::SetNumberOfPieces ( unsigned int )

protectedvirtual

◆ GetDataInformationForCompositeIndex()

vtkPVDataInformation* vtkPVCompositeDataInformation::GetDataInformationForCompositeIndex ( int * index )

protected

Friends And Related Function Documentation

◆ vtkPVDataInformation

friend class vtkPVDataInformation

friend

Definition at line 132 of file vtkPVCompositeDataInformation.h.

Member Data Documentation

◆ DataIsMultiPiece

int vtkPVCompositeDataInformation::DataIsMultiPiece

protected

Definition at line 123 of file vtkPVCompositeDataInformation.h.

◆ DataIsComposite

int vtkPVCompositeDataInformation::DataIsComposite

protected

Definition at line 124 of file vtkPVCompositeDataInformation.h.

◆ FlatIndexMax

unsigned int vtkPVCompositeDataInformation::FlatIndexMax

protected

Definition at line 125 of file vtkPVCompositeDataInformation.h.

◆ NumberOfPieces

unsigned int vtkPVCompositeDataInformation::NumberOfPieces

protected

Definition at line 127 of file vtkPVCompositeDataInformation.h.

◆ NumberOfAMRLevels

unsigned int vtkPVCompositeDataInformation::NumberOfAMRLevels

protected

Definition at line 128 of file vtkPVCompositeDataInformation.h.

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

/builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVCompositeDataInformation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPVCompositeDataInformation()

◆ ~vtkPVCompositeDataInformation()

Member Function Documentation

◆ New()

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ CopyFromObject()

◆ AddInformation()

◆ CopyToStream()

◆ CopyFromStream()

◆ Initialize()

◆ GetNumberOfChildren()

◆ GetDataInformation()

◆ GetName()

◆ GetDataIsMultiPiece()

◆ GetDataIsComposite()

◆ GetNumberOfAMRLevels()

◆ CopyFromAMR()

◆ SetNumberOfPieces()

◆ GetDataInformationForCompositeIndex()

Friends And Related Function Documentation

◆ vtkPVDataInformation

Member Data Documentation

◆ DataIsMultiPiece

◆ DataIsComposite

◆ FlatIndexMax

◆ NumberOfPieces

◆ NumberOfAMRLevels