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

extends vtkPVDataInformation to gather information across timesteps. More...

#include <vtkPVTemporalDataInformation.h>

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

Public Types

typedef vtkPVDataInformation Superclass
 
- Public Types inherited from vtkPVDataInformation
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...
 
- Public Member Functions inherited from vtkPVDataInformation
void Initialize ()
 Initializes and clears all values updated in CopyFromObject. More...
 
void DeepCopy (vtkPVDataInformation *info)
 Simply copies from another vtkPVDataInformation. More...
 
vtkPVArrayInformationGetArrayInformation (const char *arrayname, int fieldAssociation) const
 Finds and returns array information associated with the chosen array. More...
 
virtual int GetDataSetType ()
 Returns the data set type. More...
 
virtual int GetCompositeDataSetType ()
 Returns the type flag for composite datasets. More...
 
bool IsCompositeDataSet () const
 Returns true if the data information corresponds to a composite dataset. More...
 
bool IsNull () const
 Returns true if the data information is empty or invalid. More...
 
vtkTypeInt64 GetNumberOfElements (int elementType) const
 Returns number of elements of the chosen type in the data. More...
 
virtual vtkTypeInt64 GetNumberOfAMRLevels ()
 For vtkUniformGridAMR and subclasses, this returns the number of levels. More...
 
vtkTypeInt64 GetNumberOfAMRDataSets (vtkTypeInt64 level) const
 For vtkUniformGridAMR and subclasses, this returns the number of datasets at each level. More...
 
virtual vtkTypeInt64 GetNumberOfDataSets ()
 This is count of non-null non-composite datasets. More...
 
virtual vtkTypeInt64 GetMemorySize ()
 Returns the memory size as reported by vtkDataObject::GetActualMemorySize. More...
 
virtual doubleGetBounds ()
 Returns bounds for the dataset. More...
 
virtual void GetBounds (double &, double &, double &, double &, double &, double &)
 
virtual void GetBounds (double [6])
 
virtual vtkPVArrayInformationGetPointArrayInformation ()
 For a vtkPointSet and subclasses, this provides information about the vtkPoints array. More...
 
bool IsDataStructured () const
 Returns true if the data is structured i.e. More...
 
bool HasStructuredData () const
 Returns true if the data has structured data. More...
 
bool HasUnstructuredData () const
 Returns true if the data has unstructured data. More...
 
bool IsAttributeValid (int fieldAssociation) const
 Returns true if provided fieldAssociation is valid for this dataset, false otherwise. More...
 
virtual vtkTypeUInt64 GetFirstLeafCompositeIndex ()
 Until multiblock dataset is deprecated, applications often want to locate the composite-index for the first leaf node. More...
 
std::string GetBlockName (vtkTypeUInt64 cid) const
 Given a composite index, return the blockname, if any. More...
 
std::vector< std::stringGetBlockNames (const std::vector< std::string > &selectors, const char *assemblyName) const
 Given a collection of selectors, returns all block names for chosen blocks. More...
 
unsigned int ComputeCompositeIndexForAMR (unsigned int level, unsigned int index) const
 A helper method to convert an AMR level-index to a flat index. More...
 
virtual void SetPortNumber (int)
 Indicates which output port of an algorithm this data should information should be / has been collected from. More...
 
virtual int GetPortNumber ()
 Indicates which output port of an algorithm this data should information should be / has been collected from. More...
 
virtual void SetRank (int)
 Indicates which rank to gather the information from. More...
 
virtual int GetRank ()
 Indicates which rank to gather the information from. More...
 
virtual char * GetSubsetSelector ()
 Path if non-null, used to limit blocks from a composite dataset. More...
 
virtual void SetSubsetSelector (const char *)
 Path if non-null, used to limit blocks from a composite dataset. More...
 
virtual void SetSubsetAssemblyName (const char *)
 Get/Set the assembly to use for subsetting. More...
 
virtual char * GetSubsetAssemblyName ()
 Get/Set the assembly to use for subsetting. More...
 
void SetSubsetAssemblyNameToHierarchy ()
 Get/Set the assembly to use for subsetting. More...
 
void AddInformation (vtkPVInformation *info) override
 vtkPVInformation API implementation. More...
 
void CopyToStream (vtkClientServerStream *) override
 vtkPVInformation API implementation. More...
 
void CopyFromStream (const vtkClientServerStream *) override
 vtkPVInformation API implementation. More...
 
void CopyParametersToStream (vtkMultiProcessStream &) override
 vtkPVInformation API implementation. More...
 
void CopyParametersFromStream (vtkMultiProcessStream &) override
 vtkPVInformation API implementation. More...
 
const std::vector< int > & GetUniqueBlockTypes () const
 For a composite dataset, returns a list of unique data set types for all non-null leaf nodes. More...
 
unsigned int GetNumberOfUniqueBlockTypes () const
 For a composite dataset, returns a list of unique data set types for all non-null leaf nodes. More...
 
int GetUniqueBlockType (unsigned int index) const
 For a composite dataset, returns a list of unique data set types for all non-null leaf nodes. More...
 
bool DataSetTypeIsA (const char *classname) const
 Returns true if the type is of the requested classname (or typeId). More...
 
bool DataSetTypeIsA (int typeId) const
 Returns true if the type is of the requested classname (or typeId). More...
 
bool HasDataSetType (const char *classname) const
 Similar to DataSetTypeIsA except, in case of composite datasets, returns true if any of the leaf nodes match the requested type. More...
 
bool HasDataSetType (int typeId) const
 Similar to DataSetTypeIsA except, in case of composite datasets, returns true if any of the leaf nodes match the requested type. More...
 
vtkTypeInt64 GetNumberOfPoints () const
 Convenience methods that simply call GetNumberOfElements with appropriate element type. More...
 
vtkTypeInt64 GetNumberOfCells () const
 Convenience methods that simply call GetNumberOfElements with appropriate element type. More...
 
vtkTypeInt64 GetNumberOfVertices () const
 Convenience methods that simply call GetNumberOfElements with appropriate element type. More...
 
vtkTypeInt64 GetNumberOfEdges () const
 Convenience methods that simply call GetNumberOfElements with appropriate element type. More...
 
vtkTypeInt64 GetNumberOfRows () const
 Convenience methods that simply call GetNumberOfElements with appropriate element type. More...
 
virtual vtkTypeInt64 GetNumberOfTrees ()
 vtkHyperTreeGrid / vtkUniformHyperTreeGrid specific properties. More...
 
virtual vtkTypeInt64 GetNumberOfLeaves ()
 vtkHyperTreeGrid / vtkUniformHyperTreeGrid specific properties. More...
 
virtual intGetExtent ()
 Returns structured extents for the data. More...
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 Returns structured extents for the data. More...
 
virtual void GetExtent (int [6])
 Returns structured extents for the data. More...
 
vtkPVDataSetAttributesInformationGetAttributeInformation (int fieldAssociation) const
 Get vtkPVDataSetAttributesInformation information for the given association. More...
 
vtkPVDataSetAttributesInformationGetPointDataInformation () const
 Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...
 
vtkPVDataSetAttributesInformationGetCellDataInformation () const
 Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...
 
vtkPVDataSetAttributesInformationGetVertexDataInformation () const
 Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...
 
vtkPVDataSetAttributesInformationGetEdgeDataInformation () const
 Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...
 
vtkPVDataSetAttributesInformationGetRowDataInformation () const
 Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...
 
vtkPVDataSetAttributesInformationGetFieldDataInformation () const
 Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...
 
virtual bool GetHasTime ()
 Returns DATA_TIME_STEP, if any, provided by the information object associated with data. More...
 
virtual double GetTime ()
 Returns DATA_TIME_STEP, if any, provided by the information object associated with data. More...
 
virtual doubleGetTimeRange ()
 Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data. More...
 
virtual void GetTimeRange (double &, double &)
 Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data. More...
 
virtual void GetTimeRange (double [2])
 Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data. More...
 
virtual vtkTypeInt64 GetNumberOfTimeSteps ()
 Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data. More...
 
virtual std::string GetTimeLabel ()
 Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data. More...
 
vtkDataAssembly * GetHierarchy () const
 For composite datasets, this provides access to the information about the dataset hierarchy and any data assembly associated with it. More...
 
vtkDataAssembly * GetDataAssembly () const
 For composite datasets, this provides access to the information about the dataset hierarchy and any data assembly associated with it. More...
 
vtkDataAssembly * GetDataAssembly (const char *assemblyName) const
 For composite datasets, this provides access to the information about the dataset hierarchy and any data assembly associated with it. More...
 
const char * GetDataSetTypeAsString () const
 Returns a string for the given type. More...
 
const char * GetDataClassName () const
 Returns a string for the given type. More...
 
const char * GetCompositeDataClassName () const
 Returns a string for the given type. More...
 
const char * GetPrettyDataTypeString () const
 Returns a user-friendly string describing the datatype. 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)
 
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 vtkPVTemporalDataInformationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVTemporalDataInformationSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkPVDataInformation
static vtkPVDataInformationNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPVDataInformationSafeDownCast (vtkObject *o)
 
static int GetExtentType (int dataType)
 Returns the extent type for a given data-object type. More...
 
static const char * GetDataSetTypeAsString (int type)
 Returns a string for the given type. More...
 
static const char * GetPrettyDataTypeString (int dtype)
 Returns a user-friendly string describing the datatype. More...
 
- Static Public Member Functions inherited from vtkPVInformation
static int IsTypeOf (const char *type)
 
static vtkPVInformationSafeDownCast (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

 vtkPVTemporalDataInformation ()
 
 ~vtkPVTemporalDataInformation () override
 
- Protected Member Functions inherited from vtkPVDataInformation
 vtkPVDataInformation ()
 
 ~vtkPVDataInformation () override
 
void CopyFromPipelineInformation (vtkInformation *pipelineInfo)
 Populate information object with contents from producer pipeline's output port information. More...
 
void CopyFromDataObject (vtkDataObject *dobj)
 
vtkSmartPointer< vtkDataObjectGetSubset (vtkDataObject *dobj) const
 Extracts selected blocks. More...
 
- 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 &)
 

Additional Inherited Members

- 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

extends vtkPVDataInformation to gather information across timesteps.

vtkPVTemporalDataInformation is used to gather data information over time. It simply overrides vtkPVDataInformation::CopyFromObject to ensure that the data information is collected from all timesteps and not just 1.

Definition at line 33 of file vtkPVTemporalDataInformation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 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 vtkPVDataInformation.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVDataInformation.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkPVDataInformation.

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


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