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

#include <vtkPVDataInformation.h>

Inheritance diagram for vtkPVDataInformation:

[legend]

Collaboration diagram for vtkPVDataInformation:

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

vtkPVArrayInformation *	GetArrayInformation (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 double *	GetBounds ()
	Returns bounds for the dataset. More...

virtual void	GetBounds (double &, double &, double &, double &, double &, double &)

virtual void	GetBounds (double [6])

virtual vtkPVArrayInformation *	GetPointArrayInformation ()
	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::string >	GetBlockNames (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 int *	GetExtent ()
	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...


vtkPVDataSetAttributesInformation *	GetAttributeInformation (int fieldAssociation) const
	Get vtkPVDataSetAttributesInformation information for the given association. More...


vtkPVDataSetAttributesInformation *	GetPointDataInformation () const
	Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...

vtkPVDataSetAttributesInformation *	GetCellDataInformation () const
	Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...

vtkPVDataSetAttributesInformation *	GetVertexDataInformation () const
	Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...

vtkPVDataSetAttributesInformation *	GetEdgeDataInformation () const
	Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...

vtkPVDataSetAttributesInformation *	GetRowDataInformation () const
	Convenience methods to get vtkPVDataSetAttributesInformation for specific field type. More...

vtkPVDataSetAttributesInformation *	GetFieldDataInformation () 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 double *	GetTimeRange ()
	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 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...

const std::set< double > &	GetTimeSteps () const
	Strictly speaking, these are not data information since these cannot be obtained from the data but from the pipeline producing the data. More...

vtkTypeInt64	GetNumberOfTimeSteps () const
	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)

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

static int	IsTypeOf (const char *type)

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

	~vtkPVDataInformation () override

void	CopyFromPipelineInformation (vtkInformation *pipelineInfo)
	Populate information object with contents from producer pipeline's output port information. More...

void	CopyFromDataObject (vtkDataObject *dobj)

virtual vtkSmartPointer< vtkCompositeDataSet >	SimplifyCompositeDataSet (vtkCompositeDataSet *cd)
	Simplifies a composite dataset for faster processing when accumulating data-information. More...

vtkSmartPointer< vtkDataObject >	GetSubset (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...

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 42 of file vtkPVDataInformation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkPVInformation vtkPVDataInformation::Superclass

Definition at line 46 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

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVTemporalDataInformation, and vtkPVRepresentedDataInformation.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVTemporalDataInformation, and vtkPVRepresentedDataInformation.

◆ 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 146 of file vtkPVDataInformation.h.

◆ IsNull()

bool vtkPVDataInformation::IsNull ( ) const

inline

Returns true if the data information is empty or invalid.

Definition at line 151 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 161 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 162 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 177 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 181 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 185 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 241 of file vtkPVDataInformation.h.

◆ GetNumberOfCells()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfCells ( ) const

inline

Convenience methods that simply call GetNumberOfElements with appropriate element type.

Definition at line 242 of file vtkPVDataInformation.h.

◆ GetNumberOfVertices()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfVertices ( ) const

inline

Convenience methods that simply call GetNumberOfElements with appropriate element type.

Definition at line 243 of file vtkPVDataInformation.h.

◆ GetNumberOfEdges()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfEdges ( ) const

inline

Convenience methods that simply call GetNumberOfElements with appropriate element type.

Definition at line 247 of file vtkPVDataInformation.h.

◆ GetNumberOfRows()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfRows ( ) const

inline

Convenience methods that simply call GetNumberOfElements with appropriate element type.

Definition at line 248 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 328 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 332 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 336 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 340 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 344 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 348 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.