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

provides meta data about a vtkDataObject subclass. More...

#include <vtkPVDataInformation.h>

Inheritance diagram for vtkPVDataInformation:
Inheritance graph
[legend]
Collaboration diagram for vtkPVDataInformation:
Collaboration graph
[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 *object) override
 Populate vtkPVDataInformation using object. More...
 
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...
 
- Public Member Functions inherited from vtkPVInformation
void PrintSelf (ostream &os, vtkIndent indent) override
 
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 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 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

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

Friends

class vtkPVDataInformationHelper
 
class vtkPVDataInformationAccumulator
 
static const char * GetDataSetTypeAsString (int type)
 Returns a string for the given type. 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...
 
static const char * GetPrettyDataTypeString (int dtype)
 Returns a user-friendly string describing the datatype. More...
 
const char * GetPrettyDataTypeString () const
 Returns a user-friendly string describing the datatype. More...
 
static void RegisterHelper (const char *, const char *)
 Deprecated in ParaView 5.10. More...
 
vtkTypeUInt64 GetPolygonCount ()
 Deprecated in ParaView 5.10. More...
 
void * GetCompositeDataInformation ()
 Deprecated in ParaView 5.10. More...
 
vtkPVDataInformationGetDataInformationForCompositeIndex (int)
 Deprecated in ParaView 5.10. More...
 
unsigned int GetNumberOfBlockLeafs (bool skipEmpty)
 Deprecated in ParaView 5.10. More...
 
vtkPVDataInformationGetDataInformationForCompositeIndex (int *)
 Deprecated in ParaView 5.10. More...
 
doubleGetTimeSpan ()
 Deprecated in ParaView 5.10. More...
 
void GetTimeSpan (double &, double &)
 Deprecated in ParaView 5.10. More...
 
void GetTimeSpan (double[2])
 Deprecated in ParaView 5.10. More...
 

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

provides meta data about a vtkDataObject subclass.

vtkPVDataInformation is a vtkPVInformation subclass intended to collect information from vtkDataObject and subclasses. It designed to be used by application in lieu of actual data to glean insight into the data e.g. data type, number of points, number of cells, arrays, ranges etc.

Definition at line 53 of file vtkPVDataInformation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 57 of file vtkPVDataInformation.h.

Constructor & Destructor Documentation

◆ vtkPVDataInformation()

vtkPVDataInformation::vtkPVDataInformation ( )
protected

◆ ~vtkPVDataInformation()

vtkPVDataInformation::~vtkPVDataInformation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkPVDataInformation* vtkPVDataInformation::New ( )
static

◆ GetClassName()

virtual const char* vtkPVDataInformation::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkObject.

Reimplemented in vtkPVTemporalDataInformation, and vtkPVRepresentedDataInformation.

◆ SetPortNumber()

virtual void vtkPVDataInformation::SetPortNumber ( int  )
virtual

Indicates which output port of an algorithm this data should information should be / has been collected from.

Default is 0.

◆ GetPortNumber()

virtual int vtkPVDataInformation::GetPortNumber ( )
virtual

Indicates which output port of an algorithm this data should information should be / has been collected from.

Default is 0.

◆ SetRank()

virtual void vtkPVDataInformation::SetRank ( int  )
virtual

Indicates which rank to gather the information from.

Default is -1 which means all ranks.

◆ GetRank()

virtual int vtkPVDataInformation::GetRank ( )
virtual

Indicates which rank to gather the information from.

Default is -1 which means all ranks.

◆ GetSubsetSelector()

virtual char* vtkPVDataInformation::GetSubsetSelector ( )
virtual

Path if non-null, used to limit blocks from a composite dataset.

For details on support form of selector expressions see vtkDataAssembly::SelectNodes.

◆ SetSubsetSelector()

virtual void vtkPVDataInformation::SetSubsetSelector ( const char *  )
virtual

Path if non-null, used to limit blocks from a composite dataset.

For details on support form of selector expressions see vtkDataAssembly::SelectNodes.

◆ SetSubsetAssemblyName()

virtual void vtkPVDataInformation::SetSubsetAssemblyName ( const char *  )
virtual

Get/Set the assembly to use for subsetting.

To use hierarchy, set this to vtkDataAssembly::HierarchyName() or simply use SetSubsetAssemblyNameToHierarchy().

◆ GetSubsetAssemblyName()

virtual char* vtkPVDataInformation::GetSubsetAssemblyName ( )
virtual

Get/Set the assembly to use for subsetting.

To use hierarchy, set this to vtkDataAssembly::HierarchyName() or simply use SetSubsetAssemblyNameToHierarchy().

◆ SetSubsetAssemblyNameToHierarchy()

void vtkPVDataInformation::SetSubsetAssemblyNameToHierarchy ( )

Get/Set the assembly to use for subsetting.

To use hierarchy, set this to vtkDataAssembly::HierarchyName() or simply use SetSubsetAssemblyNameToHierarchy().

◆ CopyFromObject()

void vtkPVDataInformation::CopyFromObject ( vtkObject object)
overridevirtual

Populate vtkPVDataInformation using object.

The object can be a vtkDataObject, vtkAlgorithm or vtkAlgorithmOutput.

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVTemporalDataInformation, and vtkPVRepresentedDataInformation.

◆ AddInformation()

void vtkPVDataInformation::AddInformation ( vtkPVInformation info)
overridevirtual

vtkPVInformation API implementation.

Reimplemented from vtkPVInformation.

◆ CopyToStream()

void vtkPVDataInformation::CopyToStream ( vtkClientServerStream )
overridevirtual

vtkPVInformation API implementation.

Implements vtkPVInformation.

◆ CopyFromStream()

void vtkPVDataInformation::CopyFromStream ( const vtkClientServerStream )
overridevirtual

vtkPVInformation API implementation.

Reimplemented from vtkPVInformation.

◆ CopyParametersToStream()

void vtkPVDataInformation::CopyParametersToStream ( vtkMultiProcessStream )
overridevirtual

vtkPVInformation API implementation.

Reimplemented from vtkPVInformation.

◆ CopyParametersFromStream()

void vtkPVDataInformation::CopyParametersFromStream ( vtkMultiProcessStream )
overridevirtual

vtkPVInformation API implementation.

Reimplemented from vtkPVInformation.

◆ Initialize()

void vtkPVDataInformation::Initialize ( )

Initializes and clears all values updated in CopyFromObject.

◆ DeepCopy()

void vtkPVDataInformation::DeepCopy ( vtkPVDataInformation info)

Simply copies from another vtkPVDataInformation.

◆ GetArrayInformation()

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

Finds and returns array information associated with the chosen array.

fieldAssociation must be one of vtkDataObject::FieldAssociations or vtkDataObject::AttributeTypes.

◆ GetDataSetType()

virtual int vtkPVDataInformation::GetDataSetType ( )
virtual

Returns the data set type.

Returned values are defined in vtkType.h. For composite datasets, this returns the common superclass for all non-null leaf nodes in the composite dataset.

-1 indicates that the information has not be collected yet, was collected from nullptr data object, or from a composite dataset with no non-null leaf nodes.

See also
GetCompositeDataSetType

◆ GetCompositeDataSetType()

virtual int vtkPVDataInformation::GetCompositeDataSetType ( )
virtual

Returns the type flag for composite datasets.

For non-composite datasets, this is set to -1.

◆ IsCompositeDataSet()

bool vtkPVDataInformation::IsCompositeDataSet ( ) const
inline

Returns true if the data information corresponds to a composite dataset.

Definition at line 157 of file vtkPVDataInformation.h.

◆ IsNull()

bool vtkPVDataInformation::IsNull ( ) const
inline

Returns true if the data information is empty or invalid.

Definition at line 162 of file vtkPVDataInformation.h.

◆ GetUniqueBlockTypes()

const std::vector<int>& vtkPVDataInformation::GetUniqueBlockTypes ( ) const
inline

For a composite dataset, returns a list of unique data set types for all non-null leaf nodes.

May be empty if there are non-null leaf nodes are the dataset is not a composite dataset.

Note
There is no significance to the order of the types.

Definition at line 172 of file vtkPVDataInformation.h.

◆ GetNumberOfUniqueBlockTypes()

unsigned int vtkPVDataInformation::GetNumberOfUniqueBlockTypes ( ) const
inline

For a composite dataset, returns a list of unique data set types for all non-null leaf nodes.

May be empty if there are non-null leaf nodes are the dataset is not a composite dataset.

Note
There is no significance to the order of the types.

Definition at line 173 of file vtkPVDataInformation.h.

◆ GetUniqueBlockType()

int vtkPVDataInformation::GetUniqueBlockType ( unsigned int  index) const

For a composite dataset, returns a list of unique data set types for all non-null leaf nodes.

May be empty if there are non-null leaf nodes are the dataset is not a composite dataset.

Note
There is no significance to the order of the types.

◆ GetDataSetTypeAsString() [1/2]

static const char* vtkPVDataInformation::GetDataSetTypeAsString ( int  type)
static

Returns a string for the given type.

This directly returns the classname and hence may not be user-friendly.

See also
GetPrettyDataTypeString

◆ GetDataSetTypeAsString() [2/2]

const char* vtkPVDataInformation::GetDataSetTypeAsString ( ) const
inline

Returns a string for the given type.

This directly returns the classname and hence may not be user-friendly.

See also
GetPrettyDataTypeString

Definition at line 188 of file vtkPVDataInformation.h.

◆ GetDataClassName()

const char* vtkPVDataInformation::GetDataClassName ( ) const
inline

Returns a string for the given type.

This directly returns the classname and hence may not be user-friendly.

See also
GetPrettyDataTypeString

Definition at line 192 of file vtkPVDataInformation.h.

◆ GetCompositeDataClassName()

const char* vtkPVDataInformation::GetCompositeDataClassName ( ) const
inline

Returns a string for the given type.

This directly returns the classname and hence may not be user-friendly.

See also
GetPrettyDataTypeString

Definition at line 196 of file vtkPVDataInformation.h.

◆ GetPrettyDataTypeString() [1/2]

const char* vtkPVDataInformation::GetPrettyDataTypeString ( ) const

Returns a user-friendly string describing the datatype.

◆ GetPrettyDataTypeString() [2/2]

static const char* vtkPVDataInformation::GetPrettyDataTypeString ( int  dtype)
static

Returns a user-friendly string describing the datatype.

◆ DataSetTypeIsA() [1/2]

bool vtkPVDataInformation::DataSetTypeIsA ( const char *  classname) const

Returns true if the type is of the requested classname (or typeId).

If this->CompositeDataSetType is valid i.e. the information represents a composite dataset, the composite dataset type is first checked. If not, this->DataSetType is checked. Since this->DataSetType is set to the most common data type among all the leaf nodes in the composite dataset, true implies all datasets in the composite dataset match the type.

See also
HasDataSetType

◆ DataSetTypeIsA() [2/2]

bool vtkPVDataInformation::DataSetTypeIsA ( int  typeId) const

Returns true if the type is of the requested classname (or typeId).

If this->CompositeDataSetType is valid i.e. the information represents a composite dataset, the composite dataset type is first checked. If not, this->DataSetType is checked. Since this->DataSetType is set to the most common data type among all the leaf nodes in the composite dataset, true implies all datasets in the composite dataset match the type.

See also
HasDataSetType

◆ HasDataSetType() [1/2]

bool vtkPVDataInformation::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.

For non-composite datasets, this is same as DataSetTypeIsA.

◆ HasDataSetType() [2/2]

bool vtkPVDataInformation::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.

For non-composite datasets, this is same as DataSetTypeIsA.

◆ GetNumberOfElements()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfElements ( int  elementType) const

Returns number of elements of the chosen type in the data.

For a composite dataset, this is a sum of the element count across all leaf nodes.

elementType must be vtkDataObject::AttributeTypes. For vtkDataObject::FIELD, and vtkDataObject::POINT_THEN_CELL returns 0.

◆ GetNumberOfPoints()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfPoints ( ) const
inline

Convenience methods that simply call GetNumberOfElements with appropriate element type.

Definition at line 252 of file vtkPVDataInformation.h.

◆ GetNumberOfCells()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfCells ( ) const
inline

Convenience methods that simply call GetNumberOfElements with appropriate element type.

Definition at line 253 of file vtkPVDataInformation.h.

◆ GetNumberOfVertices()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfVertices ( ) const
inline

Convenience methods that simply call GetNumberOfElements with appropriate element type.

Definition at line 254 of file vtkPVDataInformation.h.

◆ GetNumberOfEdges()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfEdges ( ) const
inline

Convenience methods that simply call GetNumberOfElements with appropriate element type.

Definition at line 258 of file vtkPVDataInformation.h.

◆ GetNumberOfRows()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfRows ( ) const
inline

Convenience methods that simply call GetNumberOfElements with appropriate element type.

Definition at line 259 of file vtkPVDataInformation.h.

◆ GetNumberOfTrees()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfTrees ( )
virtual

vtkHyperTreeGrid / vtkUniformHyperTreeGrid specific properties.

Will return 0 for all other data types.

◆ GetNumberOfLeaves()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfLeaves ( )
virtual

vtkHyperTreeGrid / vtkUniformHyperTreeGrid specific properties.

Will return 0 for all other data types.

◆ GetNumberOfAMRLevels()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfAMRLevels ( )
virtual

For vtkUniformGridAMR and subclasses, this returns the number of levels.

◆ GetNumberOfAMRDataSets()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfAMRDataSets ( vtkTypeInt64  level) const

For vtkUniformGridAMR and subclasses, this returns the number of datasets at each level.

◆ GetNumberOfDataSets()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfDataSets ( )
virtual

This is count of non-null non-composite datasets.

A count of 0 may mean:

  • the data is nullptr
  • the data is a composite dataset with no non-null leaf nodes A count of 1 may mean:
  • the data is non-composite dataset
  • the data is a composite dataset with exactly 1 non-null leaf node. A count of > 1 may mean:
  • the data is non-composite, but distributed across ranks.
  • the data is composite with multiple non-null leaf nodes.

◆ GetMemorySize()

virtual vtkTypeInt64 vtkPVDataInformation::GetMemorySize ( )
virtual

Returns the memory size as reported by vtkDataObject::GetActualMemorySize.

For composite datasets, this is simply a sum of the values returned by vtkDataObject::GetActualMemorySize per non-null leaf node. For datasets that share internal arrays, this will overestimate the size.

◆ GetBounds() [1/3]

virtual double* vtkPVDataInformation::GetBounds ( )
virtual

Returns bounds for the dataset.

May return an invalid bounding box for data types where bounds don't make sense. For composite datasets, this is a bounding box of all valid bounding boxes.

◆ GetBounds() [2/3]

virtual void vtkPVDataInformation::GetBounds ( double ,
double ,
double ,
double ,
double ,
double  
)
virtual

◆ GetBounds() [3/3]

virtual void vtkPVDataInformation::GetBounds ( double  [6])
virtual

◆ GetExtent() [1/3]

virtual int* vtkPVDataInformation::GetExtent ( )
virtual

Returns structured extents for the data.

These are only valid for structured data types like vtkStructuredGrid, vtkImageData etc. For composite dataset, these represent the combined extents for structured datasets in the collection.

◆ GetExtent() [2/3]

virtual void vtkPVDataInformation::GetExtent ( int ,
int ,
int ,
int ,
int ,
int  
)
virtual

Returns structured extents for the data.

These are only valid for structured data types like vtkStructuredGrid, vtkImageData etc. For composite dataset, these represent the combined extents for structured datasets in the collection.

◆ GetExtent() [3/3]

virtual void vtkPVDataInformation::GetExtent ( int  [6])
virtual

Returns structured extents for the data.

These are only valid for structured data types like vtkStructuredGrid, vtkImageData etc. For composite dataset, these represent the combined extents for structured datasets in the collection.

◆ GetAttributeInformation()

vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetAttributeInformation ( int  fieldAssociation) const

Get vtkPVDataSetAttributesInformation information for the given association.

vtkPVDataSetAttributesInformation can be used to determine available arrays and get meta-data about each of the available arrays.

fieldAssociation must be vtkDataObject::FieldAssociations (or vtkDataObject::AttributeTypes). vtkDataObject::FIELD_ASSOCIATION_POINTS_THEN_CELLS (or vtkDataObject::POINT_THEN_CELL) is not supported.

◆ GetPointDataInformation()

vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetPointDataInformation ( ) const
inline

Convenience methods to get vtkPVDataSetAttributesInformation for specific field type.

Same as calling GetAttributeInformation with appropriate type.

Definition at line 339 of file vtkPVDataInformation.h.

◆ GetCellDataInformation()

vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetCellDataInformation ( ) const
inline

Convenience methods to get vtkPVDataSetAttributesInformation for specific field type.

Same as calling GetAttributeInformation with appropriate type.

Definition at line 343 of file vtkPVDataInformation.h.

◆ GetVertexDataInformation()

vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetVertexDataInformation ( ) const
inline

Convenience methods to get vtkPVDataSetAttributesInformation for specific field type.

Same as calling GetAttributeInformation with appropriate type.

Definition at line 347 of file vtkPVDataInformation.h.

◆ GetEdgeDataInformation()

vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetEdgeDataInformation ( ) const
inline

Convenience methods to get vtkPVDataSetAttributesInformation for specific field type.

Same as calling GetAttributeInformation with appropriate type.

Definition at line 351 of file vtkPVDataInformation.h.

◆ GetRowDataInformation()

vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetRowDataInformation ( ) const
inline

Convenience methods to get vtkPVDataSetAttributesInformation for specific field type.

Same as calling GetAttributeInformation with appropriate type.

Definition at line 355 of file vtkPVDataInformation.h.

◆ GetFieldDataInformation()

vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetFieldDataInformation ( ) const
inline

Convenience methods to get vtkPVDataSetAttributesInformation for specific field type.

Same as calling GetAttributeInformation with appropriate type.

Definition at line 359 of file vtkPVDataInformation.h.

◆ GetPointArrayInformation()

virtual vtkPVArrayInformation* vtkPVDataInformation::GetPointArrayInformation ( )
virtual

For a vtkPointSet and subclasses, this provides information about the vtkPoints array.

For composite datasets, this is the obtained by accumulating information from all point-sets in the collection.

◆ GetHasTime()

virtual bool vtkPVDataInformation::GetHasTime ( )
virtual

Returns DATA_TIME_STEP, if any, provided by the information object associated with data.

◆ GetTime()

virtual double vtkPVDataInformation::GetTime ( )
virtual

Returns DATA_TIME_STEP, if any, provided by the information object associated with data.

◆ GetTimeRange() [1/3]

virtual double* vtkPVDataInformation::GetTimeRange ( )
virtual

Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data.

However, they are provided as part data information for simplicity.

◆ GetTimeRange() [2/3]

virtual void vtkPVDataInformation::GetTimeRange ( double ,
double  
)
virtual

Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data.

However, they are provided as part data information for simplicity.

◆ GetTimeRange() [3/3]

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

Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data.

However, they are provided as part data information for simplicity.

◆ GetNumberOfTimeSteps()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfTimeSteps ( )
virtual

Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data.

However, they are provided as part data information for simplicity.

◆ GetTimeLabel()

virtual std::string vtkPVDataInformation::GetTimeLabel ( )
virtual

Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data.

However, they are provided as part data information for simplicity.

◆ IsDataStructured()

bool vtkPVDataInformation::IsDataStructured ( ) const

Returns true if the data is structured i.e.

supports i-j-k indexing. For composite datasets, this returns true if all leaf nodes are structured.

◆ HasStructuredData()

bool vtkPVDataInformation::HasStructuredData ( ) const

Returns true if the data has structured data.

For composite datasets, this returns true if any of the datasets are structured.

◆ HasUnstructuredData()

bool vtkPVDataInformation::HasUnstructuredData ( ) const

Returns true if the data has unstructured data.

For composite datasets, this returns true if any of the datasets are unstructured.

◆ IsAttributeValid()

bool vtkPVDataInformation::IsAttributeValid ( int  fieldAssociation) const

Returns true if provided fieldAssociation is valid for this dataset, false otherwise.

For composite datasets, this returns true if the attribute type if valid for any of the datasets in the collection.

◆ GetExtentType()

static int vtkPVDataInformation::GetExtentType ( int  dataType)
static

Returns the extent type for a given data-object type.

◆ GetHierarchy()

vtkDataAssembly* vtkPVDataInformation::GetHierarchy ( ) const

For composite datasets, this provides access to the information about the dataset hierarchy and any data assembly associated with it.

Hierarchy represents the hierarchy of the datatype while assembly provides access to logical grouping and organization, if any.

◆ GetDataAssembly() [1/2]

vtkDataAssembly* vtkPVDataInformation::GetDataAssembly ( ) const

For composite datasets, this provides access to the information about the dataset hierarchy and any data assembly associated with it.

Hierarchy represents the hierarchy of the datatype while assembly provides access to logical grouping and organization, if any.

◆ GetDataAssembly() [2/2]

vtkDataAssembly* vtkPVDataInformation::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.

Hierarchy represents the hierarchy of the datatype while assembly provides access to logical grouping and organization, if any.

◆ GetFirstLeafCompositeIndex()

virtual vtkTypeUInt64 vtkPVDataInformation::GetFirstLeafCompositeIndex ( )
virtual

Until multiblock dataset is deprecated, applications often want to locate the composite-index for the first leaf node.

Returns 0 if not applicable.

◆ GetBlockName()

std::string vtkPVDataInformation::GetBlockName ( vtkTypeUInt64  cid) const

Given a composite index, return the blockname, if any.

Note, this is not reliable if executed on partitioned-dataset collection since partitioned-dataset collection may have different composite indices across ranks. Thus, this must only be used in code that is currently only slated for migration from using composite-ids to selectors and hence does not encounter partitioned-dataset collections.

This uses Hierarchy and hence it only supported when hierarchy is defined/available.

Returns empty string if no name available or cannot be determined.

◆ GetBlockNames()

std::vector<std::string> vtkPVDataInformation::GetBlockNames ( const std::vector< std::string > &  selectors,
const char *  assemblyName 
) const

Given a collection of selectors, returns all block names for chosen blocks.

◆ ComputeCompositeIndexForAMR()

unsigned int vtkPVDataInformation::ComputeCompositeIndexForAMR ( unsigned int  level,
unsigned int  index 
) const

A helper method to convert an AMR level-index to a flat index.

This uses the hierarchy to compute the flat index.

Calling this on a non-AMR dataset will simply return 0.

◆ GetPolygonCount()

vtkTypeUInt64 vtkPVDataInformation::GetPolygonCount ( )

Deprecated in ParaView 5.10.

◆ GetCompositeDataInformation()

void* vtkPVDataInformation::GetCompositeDataInformation ( )

Deprecated in ParaView 5.10.

◆ GetDataInformationForCompositeIndex() [1/2]

vtkPVDataInformation* vtkPVDataInformation::GetDataInformationForCompositeIndex ( int  )

Deprecated in ParaView 5.10.

◆ GetNumberOfBlockLeafs()

unsigned int vtkPVDataInformation::GetNumberOfBlockLeafs ( bool  skipEmpty)

Deprecated in ParaView 5.10.

◆ GetDataInformationForCompositeIndex() [2/2]

vtkPVDataInformation* vtkPVDataInformation::GetDataInformationForCompositeIndex ( int )

Deprecated in ParaView 5.10.

◆ GetTimeSpan() [1/3]

double* vtkPVDataInformation::GetTimeSpan ( )

Deprecated in ParaView 5.10.

◆ GetTimeSpan() [2/3]

void vtkPVDataInformation::GetTimeSpan ( double ,
double  
)

Deprecated in ParaView 5.10.

◆ GetTimeSpan() [3/3]

void vtkPVDataInformation::GetTimeSpan ( double  [2])

Deprecated in ParaView 5.10.

◆ RegisterHelper()

static void vtkPVDataInformation::RegisterHelper ( const char *  ,
const char *   
)
static

Deprecated in ParaView 5.10.

◆ CopyFromPipelineInformation()

void vtkPVDataInformation::CopyFromPipelineInformation ( vtkInformation pipelineInfo)
protected

Populate information object with contents from producer pipeline's output port information.

◆ CopyFromDataObject()

void vtkPVDataInformation::CopyFromDataObject ( vtkDataObject dobj)
protected

◆ GetSubset()

vtkSmartPointer<vtkDataObject> vtkPVDataInformation::GetSubset ( vtkDataObject dobj) const
protected

Extracts selected blocks.

Use SubsetSelector and SubsetAssemblyName to extract chosen part of the composite dataset and returns that.

Friends And Related Function Documentation

◆ vtkPVDataInformationHelper

friend class vtkPVDataInformationHelper
friend

Definition at line 506 of file vtkPVDataInformation.h.

◆ vtkPVDataInformationAccumulator

friend class vtkPVDataInformationAccumulator
friend

Definition at line 551 of file vtkPVDataInformation.h.


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