vtkPVTemporalDataInformation Class Reference

vtkPVTemporalDataInformation is used to gather data information over time. More...

#include <vtkPVTemporalDataInformation.h>

Inheritance diagram for vtkPVTemporalDataInformation:

Collaboration diagram for vtkPVTemporalDataInformation:

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 *object) override
	Transfer information about a single object into this object. More...
void	AddInformation (vtkPVInformation *info) override
	Merge another information object. More...
void	Initialize ()
	Initializes the information object. More...
vtkPVDataSetAttributesInformation *	GetAttributeInformation (int attr)
	Convenience method to get the attribute information given the attribute type. More...
vtkPVArrayInformation *	GetArrayInformation (const char *arrayname, int fieldAssociation)
	Method to find and return attribute array information for a particular array for the given attribute type if one exists. More...
virtual void	SetPortNumber (int)
	Port number controls which output port the information is gathered from. 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...
void	CopyParametersToStream (vtkMultiProcessStream &) override
	Serialize/Deserialize the parameters that control how/what information is gathered. More...
void	CopyParametersFromStream (vtkMultiProcessStream &) override
	Serialize/Deserialize the parameters that control how/what information is gathered. More...
virtual int	GetNumberOfTimeSteps ()
	Returns the number of timesteps this information was gathered from. More...
virtual double *	GetTimeRange ()
	Returns the time-range this information was gathered from. More...
virtual void	GetTimeRange (double &, double &)
	Returns the time-range this information was gathered from. More...
virtual void	GetTimeRange (double [2])
	Returns the time-range this information was gathered from. More...
virtual vtkPVDataSetAttributesInformation *	GetPointDataInformation ()
	Access to information about point/cell/vertex/edge/row data. More...
virtual vtkPVDataSetAttributesInformation *	GetCellDataInformation ()
	Access to information about point/cell/vertex/edge/row data. More...
virtual vtkPVDataSetAttributesInformation *	GetVertexDataInformation ()
	Access to information about point/cell/vertex/edge/row data. More...
virtual vtkPVDataSetAttributesInformation *	GetEdgeDataInformation ()
	Access to information about point/cell/vertex/edge/row data. More...
virtual vtkPVDataSetAttributesInformation *	GetRowDataInformation ()
	Access to information about point/cell/vertex/edge/row data. More...
virtual vtkPVDataSetAttributesInformation *	GetFieldDataInformation ()
	Access to information about field data, if any. More...
Public Member Functions inherited from vtkPVInformation
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 vtkPVTemporalDataInformation *	New ()
static int	IsTypeOf (const char *type)
static vtkPVTemporalDataInformation *	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
	vtkPVTemporalDataInformation ()
	~vtkPVTemporalDataInformation () override
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
vtkPVDataSetAttributesInformation *	PointDataInformation
vtkPVDataSetAttributesInformation *	CellDataInformation
vtkPVDataSetAttributesInformation *	FieldDataInformation
vtkPVDataSetAttributesInformation *	VertexDataInformation
vtkPVDataSetAttributesInformation *	EdgeDataInformation
vtkPVDataSetAttributesInformation *	RowDataInformation
double	TimeRange [2]
int	NumberOfTimeSteps
int	PortNumber
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

vtkPVTemporalDataInformation is used to gather data information over time.

This information provided by this class is a sub-set of vtkPVDataInformation and hence this is not directly a subclass of vtkPVDataInformation. It internally uses vtkPVDataInformation to collect information about each timestep.

Definition at line 34 of file vtkPVTemporalDataInformation.h.

Member Typedef Documentation

Superclass

typedef vtkPVInformation vtkPVTemporalDataInformation::Superclass

Definition at line 38 of file vtkPVTemporalDataInformation.h.

Constructor & Destructor Documentation

vtkPVTemporalDataInformation()

vtkPVTemporalDataInformation::vtkPVTemporalDataInformation ( )

protected

~vtkPVTemporalDataInformation()

vtkPVTemporalDataInformation::~vtkPVTemporalDataInformation ( )

overrideprotected

Member Function Documentation

New()

static vtkPVTemporalDataInformation* vtkPVTemporalDataInformation::New ( )

static

GetClassName()

virtual const char* vtkPVTemporalDataInformation::GetClassName ( )

virtual

Reimplemented from vtkPVInformation.

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkPVInformation.

SafeDownCast()

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

static

PrintSelf()

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

overridevirtual

Reimplemented from vtkPVInformation.

SetPortNumber()

virtual void vtkPVTemporalDataInformation::SetPortNumber ( int  )

virtual

Port number controls which output port the information is gathered from.

This is only applicable when the vtkObject from which the information being gathered is a vtkAlgorithm. Set it to -1(default), to return the classname of the vtkAlgorithm itself. This is the only parameter that can be set on the client-side before gathering the information.

CopyFromObject()

void vtkPVTemporalDataInformation::CopyFromObject ( vtkObject *  object )

overridevirtual

Transfer information about a single object into this object.

This expects the object to be a vtkAlgorithmOutput.

Reimplemented from vtkPVInformation.

AddInformation()

void vtkPVTemporalDataInformation::AddInformation ( vtkPVInformation *  info )

overridevirtual

Merge another information object.

Calls AddInformation(info, 0).

Reimplemented from vtkPVInformation.

CopyToStream()

void vtkPVTemporalDataInformation::CopyToStream ( vtkClientServerStream *  )

overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

CopyFromStream()

void vtkPVTemporalDataInformation::CopyFromStream ( const vtkClientServerStream *  )

overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

CopyParametersToStream()

void vtkPVTemporalDataInformation::CopyParametersToStream ( vtkMultiProcessStream &  )

overridevirtual

Serialize/Deserialize the parameters that control how/what information is gathered.

This are different from the ivars that constitute the gathered information itself. For example, PortNumber on vtkPVDataInformation controls what output port the data-information is gathered from.

Reimplemented from vtkPVInformation.

CopyParametersFromStream()

void vtkPVTemporalDataInformation::CopyParametersFromStream ( vtkMultiProcessStream &  )

overridevirtual

Serialize/Deserialize the parameters that control how/what information is gathered.

This are different from the ivars that constitute the gathered information itself. For example, PortNumber on vtkPVDataInformation controls what output port the data-information is gathered from.

Reimplemented from vtkPVInformation.

Initialize()

void vtkPVTemporalDataInformation::Initialize

(

)

Initializes the information object.

GetNumberOfTimeSteps()

virtual int vtkPVTemporalDataInformation::GetNumberOfTimeSteps ( )

virtual

Returns the number of timesteps this information was gathered from.

GetTimeRange() [1/3]

virtual double* vtkPVTemporalDataInformation::GetTimeRange ( )

virtual

Returns the time-range this information was gathered from.

GetTimeRange() [2/3]

virtual void vtkPVTemporalDataInformation::GetTimeRange ( double &  , double &    )

virtual

Returns the time-range this information was gathered from.

GetTimeRange() [3/3]

virtual void vtkPVTemporalDataInformation::GetTimeRange ( double  [2] )

virtual

Returns the time-range this information was gathered from.

GetPointDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetPointDataInformation ( )

virtual

Access to information about point/cell/vertex/edge/row data.

GetCellDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetCellDataInformation ( )

virtual

Access to information about point/cell/vertex/edge/row data.

GetVertexDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetVertexDataInformation ( )

virtual

Access to information about point/cell/vertex/edge/row data.

GetEdgeDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetEdgeDataInformation ( )

virtual

Access to information about point/cell/vertex/edge/row data.

GetRowDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetRowDataInformation ( )

virtual

Access to information about point/cell/vertex/edge/row data.

GetAttributeInformation()

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetAttributeInformation

(

int

attr

)

Convenience method to get the attribute information given the attribute type.

attr can be vtkDataObject::FieldAssociations or vtkDataObject::AttributeTypes (since both are identical).

GetFieldDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::GetFieldDataInformation ( )

virtual

Access to information about field data, if any.

GetArrayInformation()

vtkPVArrayInformation* vtkPVTemporalDataInformation::GetArrayInformation	(	const char *	arrayname,
		int	fieldAssociation
	)

Method to find and return attribute array information for a particular array for the given attribute type if one exists.

Returns NULL if none is found. fieldAssociation can be vtkDataObject::FIELD_ASSOCIATION_POINTS, vtkDataObject::FIELD_ASSOCIATION_CELLS etc. (use vtkDataObject::FIELD_ASSOCIATION_NONE for field data) (or vtkDataObject::POINT, vtkDataObject::CELL, vtkDataObject::FIELD).

Member Data Documentation

PointDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::PointDataInformation

protected

Definition at line 142 of file vtkPVTemporalDataInformation.h.

CellDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::CellDataInformation

protected

Definition at line 143 of file vtkPVTemporalDataInformation.h.

FieldDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::FieldDataInformation

protected

Definition at line 144 of file vtkPVTemporalDataInformation.h.

VertexDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::VertexDataInformation

protected

Definition at line 145 of file vtkPVTemporalDataInformation.h.

EdgeDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::EdgeDataInformation

protected

Definition at line 146 of file vtkPVTemporalDataInformation.h.

RowDataInformation

vtkPVDataSetAttributesInformation* vtkPVTemporalDataInformation::RowDataInformation

protected

Definition at line 147 of file vtkPVTemporalDataInformation.h.

TimeRange

double vtkPVTemporalDataInformation::TimeRange[2]

protected

Definition at line 149 of file vtkPVTemporalDataInformation.h.

NumberOfTimeSteps

int vtkPVTemporalDataInformation::NumberOfTimeSteps

protected

Definition at line 150 of file vtkPVTemporalDataInformation.h.

PortNumber

int vtkPVTemporalDataInformation::PortNumber

protected

Definition at line 151 of file vtkPVTemporalDataInformation.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVTemporalDataInformation.h