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

Light object for holding data information. 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
 
vtkPVArrayInformationGetArrayInformation (const char *arrayname, int fieldAssociation)
 Method to find and return attribute array information for a particular array for the given attribute type if one exists. More...
 
void CopyFromObject (vtkObject *) override
 Transfer information about a single object into this object. More...
 
void AddInformation (vtkPVInformation *info) override
 Merge another information object. More...
 
virtual void AddInformation (vtkPVInformation *, int addingParts)
 Merge another information object. More...
 
void Initialize ()
 Remove all information. More...
 
vtkTypeInt64 GetNumberOfElements (int type)
 Returns the number of elements of the given type where type can vtkDataObject::POINT, vtkDataObject::CELL, ... More...
 
const char * GetPrettyDataTypeString ()
 Returns a string describing the datatype that can be directly shown in a user interface. More...
 
vtkPVDataSetAttributesInformationGetAttributeInformation (int fieldAssociation)
 Method to access vtkPVDataSetAttributesInformation using field association type. More...
 
vtkPVDataInformationGetDataInformationForCompositeIndex (int index)
 Given the flat-index for a node in a composite dataset, this method returns the data information for the node, it available. More...
 
unsigned int GetNumberOfBlockLeafs (bool skipEmpty)
 Compute the number of block leaf from this information multipieces are counted as single block. More...
 
vtkPVDataInformationGetDataInformationForCompositeIndex (int *index)
 This is same as GetDataInformationForCompositeIndex() however note that the index will get modified in this method. More...
 
virtual doubleGetTimeSpan ()
 
virtual void GetTimeSpan (double &, double &)
 
virtual void GetTimeSpan (double [2])
 
bool IsDataStructured ()
 Returns if the data type is structured. More...
 
bool IsAttributeValid (int fieldAssociation)
 Returns true if provided fieldAssociation is valid for this dataset, false otherwise. More...
 
virtual void SetPortNumber (int)
 Port number controls which output port the information is gathered from. More...
 
virtual int GetPortNumber ()
 Port number controls which output port the information is gathered from. More...
 
void CopyToStream (vtkClientServerStream *) override
 Manage a serialized version of the information. More...
 
void CopyFromStream (const vtkClientServerStream *) override
 Manage a serialized version of the information. More...
 
void CopyParametersToStream (vtkMultiProcessStream &) override
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
void CopyParametersFromStream (vtkMultiProcessStream &) override
 Serialize/Deserialize the parameters that control how/what information is gathered. More...
 
virtual int GetDataSetType ()
 Access to information. More...
 
virtual int GetCompositeDataSetType ()
 Access to information. More...
 
const char * GetDataSetTypeAsString ()
 Access to information. More...
 
bool DataSetTypeIsA (const char *type)
 Access to information. More...
 
virtual vtkTypeInt64 GetNumberOfPoints ()
 Access to information. More...
 
virtual vtkTypeInt64 GetNumberOfCells ()
 Access to information. More...
 
virtual vtkTypeInt64 GetNumberOfRows ()
 Access to information. More...
 
virtual vtkTypeInt64 GetNumberOfTrees ()
 Access to information. More...
 
virtual vtkTypeInt64 GetNumberOfVertices ()
 Access to information. More...
 
virtual vtkTypeInt64 GetNumberOfEdges ()
 Access to information. More...
 
virtual vtkTypeInt64 GetNumberOfLeaves ()
 Access to information. More...
 
virtual int GetMemorySize ()
 Access to information. More...
 
virtual vtkIdType GetPolygonCount ()
 Access to information. More...
 
virtual int GetNumberOfDataSets ()
 Access to information. More...
 
virtual doubleGetBounds ()
 Access to information. More...
 
virtual void GetBounds (double &, double &, double &, double &, double &, double &)
 Access to information. More...
 
virtual void GetBounds (double [6])
 Access to information. More...
 
virtual intGetExtent ()
 Of course Extent is only valid for structured data sets. More...
 
virtual void GetExtent (int &, int &, int &, int &, int &, int &)
 Of course Extent is only valid for structured data sets. More...
 
virtual void GetExtent (int [6])
 Of course Extent is only valid for structured data sets. More...
 
virtual vtkPVArrayInformationGetPointArrayInformation ()
 Access to information about points. More...
 
virtual vtkPVDataSetAttributesInformationGetPointDataInformation ()
 Access to information about point/cell/vertex/edge/row data. More...
 
virtual vtkPVDataSetAttributesInformationGetCellDataInformation ()
 Access to information about point/cell/vertex/edge/row data. More...
 
virtual vtkPVDataSetAttributesInformationGetVertexDataInformation ()
 Access to information about point/cell/vertex/edge/row data. More...
 
virtual vtkPVDataSetAttributesInformationGetEdgeDataInformation ()
 Access to information about point/cell/vertex/edge/row data. More...
 
virtual vtkPVDataSetAttributesInformationGetRowDataInformation ()
 Access to information about point/cell/vertex/edge/row data. More...
 
virtual vtkPVDataSetAttributesInformationGetFieldDataInformation ()
 Accesse to information about field data, if any. More...
 
virtual vtkPVCompositeDataInformationGetCompositeDataInformation ()
 If data is composite, this provides information specific to composite datasets. More...
 
virtual char * GetDataClassName ()
 ClassName of the data represented by information object. More...
 
virtual char * GetCompositeDataClassName ()
 The least common class name of composite dataset blocks. More...
 
virtual int GetHasTime ()
 Returns if the Time is set. More...
 
virtual double GetTime ()
 Returns the data time if, GetHasTime() return true. More...
 
virtual int GetNumberOfTimeSteps ()
 Returns the number of time steps. More...
 
virtual char * GetTimeLabel ()
 Returns the label that should be used instead of "Time" if any. More...
 
virtual char * GetCompositeDataSetName ()
 If this instance of vtkPVDataInformation summarizes a node in a composite-dataset, and if that node has been given a label in that composite dataset (using vtkCompositeDataSet::NAME meta-data), then this will return that name. 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 void RegisterHelper (const char *classname, const char *helperclassname)
 Allows run time addition of information getters for new classes. 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 DeepCopy (vtkPVDataInformation *dataInfo, bool copyCompositeInformation=true)
 
void AddFromMultiPieceDataSet (vtkCompositeDataSet *data)
 
void CopyFromCompositeDataSet (vtkCompositeDataSet *data)
 
void CopyFromCompositeDataSetInitialize (vtkCompositeDataSet *data)
 
void CopyFromCompositeDataSetFinalize (vtkCompositeDataSet *data)
 
virtual void CopyFromDataSet (vtkDataSet *data)
 
void CopyFromGenericDataSet (vtkGenericDataSet *data)
 
void CopyFromGraph (vtkGraph *graph)
 
void CopyFromTable (vtkTable *table)
 
void CopyFromHyperTreeGrid (vtkHyperTreeGrid *data)
 
void CopyFromSelection (vtkSelection *selection)
 
void CopyCommonMetaData (vtkDataObject *, vtkInformation *)
 
virtual void SetDataClassName (const char *)
 
virtual void SetTimeLabel (const char *)
 
virtual void SetCompositeDataClassName (const char *)
 
virtual void SetCompositeDataSetName (const char *)
 
- 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 &)
 

Static Protected Member Functions

static vtkPVDataInformationHelperFindHelper (const char *classname)
 

Protected Attributes

int DataSetType = -1
 
int CompositeDataSetType = -1
 
int NumberOfDataSets = 0
 
vtkTypeInt64 NumberOfPoints = 0
 
vtkTypeInt64 NumberOfCells = 0
 
vtkTypeInt64 NumberOfRows = 0
 
vtkTypeInt64 NumberOfTrees = 0
 
vtkTypeInt64 NumberOfVertices = 0
 
vtkTypeInt64 NumberOfEdges = 0
 
vtkTypeInt64 NumberOfLeaves = 0
 
int MemorySize = 0
 
vtkIdType PolygonCount = 0
 
double Bounds [6]
 
int Extent [6]
 
double TimeSpan [2] = { VTK_DOUBLE_MAX, -VTK_DOUBLE_MAX }
 
double Time = 0.0
 
int HasTime = 0
 
int NumberOfTimeSteps = 0
 
char * DataClassName = nullptr
 
char * TimeLabel = nullptr
 
char * CompositeDataClassName = nullptr
 
char * CompositeDataSetName = nullptr
 
vtkPVDataSetAttributesInformationPointDataInformation
 
vtkPVDataSetAttributesInformationCellDataInformation
 
vtkPVDataSetAttributesInformationFieldDataInformation
 
vtkPVDataSetAttributesInformationVertexDataInformation
 
vtkPVDataSetAttributesInformationEdgeDataInformation
 
vtkPVDataSetAttributesInformationRowDataInformation
 
vtkPVCompositeDataInformationCompositeDataInformation
 
vtkPVArrayInformationPointArrayInformation
 
- Protected Attributes inherited from vtkPVInformation
int RootOnly
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkPVDataInformationHelper
 
class vtkPVCompositeDataInformation
 

Detailed Description

Light object for holding data information.

This object is a light weight object. It has no user interface and does not necessarily last a long time. It is meant to help collect information about data object and collections of data objects. It has a PV in the class name because it should never be moved into VTK.

Warning
Get polygons only works for poly data and it does not work propelry for the triangle strips.

Definition at line 51 of file vtkPVDataInformation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 55 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 vtkPVRepresentedDataInformation.

◆ IsTypeOf()

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

◆ IsA()

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

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVRepresentedDataInformation.

◆ SafeDownCast()

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

◆ PrintSelf()

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

Reimplemented from vtkObject.

Reimplemented in vtkPVRepresentedDataInformation.

◆ GetArrayInformation()

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

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

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

◆ SetPortNumber()

virtual void vtkPVDataInformation::SetPortNumber ( int  )
virtual

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

This is the only parameter that can be set on the client-side before gathering the information.

◆ GetPortNumber()

virtual int vtkPVDataInformation::GetPortNumber ( )
virtual

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

This is the only parameter that can be set on the client-side before gathering the information.

◆ CopyFromObject()

void vtkPVDataInformation::CopyFromObject ( vtkObject )
overridevirtual

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVRepresentedDataInformation.

◆ AddInformation() [1/2]

void vtkPVDataInformation::AddInformation ( vtkPVInformation info)
overridevirtual

Merge another information object.

Calls AddInformation(info, 0).

Reimplemented from vtkPVInformation.

◆ AddInformation() [2/2]

virtual void vtkPVDataInformation::AddInformation ( vtkPVInformation ,
int  addingParts 
)
virtual

Merge another information object.

If adding information of 1 part across processors, set addingParts to false. If adding information of parts, set addingParts to true.

◆ CopyToStream()

void vtkPVDataInformation::CopyToStream ( vtkClientServerStream )
overridevirtual

Manage a serialized version of the information.

Implements vtkPVInformation.

◆ CopyFromStream()

void vtkPVDataInformation::CopyFromStream ( const vtkClientServerStream )
overridevirtual

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

◆ CopyParametersToStream()

void vtkPVDataInformation::CopyParametersToStream ( vtkMultiProcessStream )
overridevirtual

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

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

Reimplemented from vtkPVInformation.

◆ CopyParametersFromStream()

void vtkPVDataInformation::CopyParametersFromStream ( vtkMultiProcessStream )
overridevirtual

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

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

Reimplemented from vtkPVInformation.

◆ Initialize()

void vtkPVDataInformation::Initialize ( )

Remove all information.

The next add will be like a copy. I might want to put this in the PVInformation superclass.

◆ GetDataSetType()

virtual int vtkPVDataInformation::GetDataSetType ( )
virtual

Access to information.

◆ GetCompositeDataSetType()

virtual int vtkPVDataInformation::GetCompositeDataSetType ( )
virtual

Access to information.

◆ GetDataSetTypeAsString()

const char* vtkPVDataInformation::GetDataSetTypeAsString ( )

Access to information.

◆ DataSetTypeIsA()

bool vtkPVDataInformation::DataSetTypeIsA ( const char *  type)

Access to information.

◆ GetNumberOfPoints()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfPoints ( )
virtual

Access to information.

◆ GetNumberOfCells()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfCells ( )
virtual

Access to information.

◆ GetNumberOfRows()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfRows ( )
virtual

Access to information.

◆ GetNumberOfTrees()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfTrees ( )
virtual

Access to information.

◆ GetNumberOfVertices()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfVertices ( )
virtual

Access to information.

◆ GetNumberOfEdges()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfEdges ( )
virtual

Access to information.

◆ GetNumberOfLeaves()

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfLeaves ( )
virtual

Access to information.

◆ GetMemorySize()

virtual int vtkPVDataInformation::GetMemorySize ( )
virtual

Access to information.

◆ GetPolygonCount()

virtual vtkIdType vtkPVDataInformation::GetPolygonCount ( )
virtual

Access to information.

◆ GetNumberOfDataSets()

virtual int vtkPVDataInformation::GetNumberOfDataSets ( )
virtual

Access to information.

◆ GetBounds() [1/3]

virtual double* vtkPVDataInformation::GetBounds ( )
virtual

Access to information.

◆ GetBounds() [2/3]

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

Access to information.

◆ GetBounds() [3/3]

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

Access to information.

◆ GetNumberOfElements()

vtkTypeInt64 vtkPVDataInformation::GetNumberOfElements ( int  type)

Returns the number of elements of the given type where type can vtkDataObject::POINT, vtkDataObject::CELL, ...

etc.

◆ GetPrettyDataTypeString()

const char* vtkPVDataInformation::GetPrettyDataTypeString ( )

Returns a string describing the datatype that can be directly shown in a user interface.

◆ GetExtent() [1/3]

virtual int* vtkPVDataInformation::GetExtent ( )
virtual

Of course Extent is only valid for structured data sets.

Extent is the largest extent that contains all the parts.

◆ GetExtent() [2/3]

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

Of course Extent is only valid for structured data sets.

Extent is the largest extent that contains all the parts.

◆ GetExtent() [3/3]

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

Of course Extent is only valid for structured data sets.

Extent is the largest extent that contains all the parts.

◆ GetPointArrayInformation()

virtual vtkPVArrayInformation* vtkPVDataInformation::GetPointArrayInformation ( )
virtual

Access to information about points.

Only valid for subclasses of vtkPointSet.

◆ GetPointDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetPointDataInformation ( )
virtual

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

◆ GetCellDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetCellDataInformation ( )
virtual

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

◆ GetVertexDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetVertexDataInformation ( )
virtual

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

◆ GetEdgeDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetEdgeDataInformation ( )
virtual

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

◆ GetRowDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetRowDataInformation ( )
virtual

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

◆ GetFieldDataInformation()

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetFieldDataInformation ( )
virtual

Accesse to information about field data, if any.

◆ GetAttributeInformation()

vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetAttributeInformation ( int  fieldAssociation)

Method to access vtkPVDataSetAttributesInformation using field association type.

fieldAssociation can be vtkDataObject::FIELD_ASSOCIATION_POINTS, vtkDataObject::FIELD_ASSOCIATION_CELLS etc. (use vtkDataObject::FIELD_ASSOCIATION_NONE for field data).

◆ GetCompositeDataInformation()

virtual vtkPVCompositeDataInformation* vtkPVDataInformation::GetCompositeDataInformation ( )
virtual

If data is composite, this provides information specific to composite datasets.

◆ GetDataInformationForCompositeIndex() [1/2]

vtkPVDataInformation* vtkPVDataInformation::GetDataInformationForCompositeIndex ( int  index)

Given the flat-index for a node in a composite dataset, this method returns the data information for the node, it available.

◆ GetNumberOfBlockLeafs()

unsigned int vtkPVDataInformation::GetNumberOfBlockLeafs ( bool  skipEmpty)

Compute the number of block leaf from this information multipieces are counted as single block.

The boolean skipEmpty parameter allows to choose to count empty dataset are not Calling this method with skipEmpty to false will correspond to the vtkBlockColors array in a multiblock.

◆ GetDataInformationForCompositeIndex() [2/2]

vtkPVDataInformation* vtkPVDataInformation::GetDataInformationForCompositeIndex ( int index)

This is same as GetDataInformationForCompositeIndex() however note that the index will get modified in this method.

◆ GetDataClassName()

virtual char* vtkPVDataInformation::GetDataClassName ( )
virtual

ClassName of the data represented by information object.

◆ GetCompositeDataClassName()

virtual char* vtkPVDataInformation::GetCompositeDataClassName ( )
virtual

The least common class name of composite dataset blocks.

◆ GetTimeSpan() [1/3]

virtual double* vtkPVDataInformation::GetTimeSpan ( )
virtual

◆ GetTimeSpan() [2/3]

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

◆ GetTimeSpan() [3/3]

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

◆ GetHasTime()

virtual int vtkPVDataInformation::GetHasTime ( )
virtual

Returns if the Time is set.

◆ GetTime()

virtual double vtkPVDataInformation::GetTime ( )
virtual

Returns the data time if, GetHasTime() return true.

◆ GetNumberOfTimeSteps()

virtual int vtkPVDataInformation::GetNumberOfTimeSteps ( )
virtual

Returns the number of time steps.

◆ GetTimeLabel()

virtual char* vtkPVDataInformation::GetTimeLabel ( )
virtual

Returns the label that should be used instead of "Time" if any.

◆ IsDataStructured()

bool vtkPVDataInformation::IsDataStructured ( )

Returns if the data type is structured.

◆ IsAttributeValid()

bool vtkPVDataInformation::IsAttributeValid ( int  fieldAssociation)

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

Always returns true for composite datasets. eg, FIELD_ASSOCIATION_EDGES will return false for a vtkPolyData, true for a vtkGraph.

◆ GetCompositeDataSetName()

virtual char* vtkPVDataInformation::GetCompositeDataSetName ( )
virtual

If this instance of vtkPVDataInformation summarizes a node in a composite-dataset, and if that node has been given a label in that composite dataset (using vtkCompositeDataSet::NAME meta-data), then this will return that name.

Returns NULL if this instance doesn't represent a node in a composite dataset or doesn't have a label/name associated with it.

◆ RegisterHelper()

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

Allows run time addition of information getters for new classes.

◆ DeepCopy()

void vtkPVDataInformation::DeepCopy ( vtkPVDataInformation dataInfo,
bool  copyCompositeInformation = true 
)
protected

◆ AddFromMultiPieceDataSet()

void vtkPVDataInformation::AddFromMultiPieceDataSet ( vtkCompositeDataSet data)
protected

◆ CopyFromCompositeDataSet()

void vtkPVDataInformation::CopyFromCompositeDataSet ( vtkCompositeDataSet data)
protected

◆ CopyFromCompositeDataSetInitialize()

void vtkPVDataInformation::CopyFromCompositeDataSetInitialize ( vtkCompositeDataSet data)
protected

◆ CopyFromCompositeDataSetFinalize()

void vtkPVDataInformation::CopyFromCompositeDataSetFinalize ( vtkCompositeDataSet data)
protected

◆ CopyFromDataSet()

virtual void vtkPVDataInformation::CopyFromDataSet ( vtkDataSet data)
protectedvirtual

◆ CopyFromGenericDataSet()

void vtkPVDataInformation::CopyFromGenericDataSet ( vtkGenericDataSet data)
protected

◆ CopyFromGraph()

void vtkPVDataInformation::CopyFromGraph ( vtkGraph graph)
protected

◆ CopyFromTable()

void vtkPVDataInformation::CopyFromTable ( vtkTable table)
protected

◆ CopyFromHyperTreeGrid()

void vtkPVDataInformation::CopyFromHyperTreeGrid ( vtkHyperTreeGrid data)
protected

◆ CopyFromSelection()

void vtkPVDataInformation::CopyFromSelection ( vtkSelection selection)
protected

◆ CopyCommonMetaData()

void vtkPVDataInformation::CopyCommonMetaData ( vtkDataObject ,
vtkInformation  
)
protected

◆ FindHelper()

static vtkPVDataInformationHelper* vtkPVDataInformation::FindHelper ( const char *  classname)
staticprotected

◆ SetDataClassName()

virtual void vtkPVDataInformation::SetDataClassName ( const char *  )
protectedvirtual

◆ SetTimeLabel()

virtual void vtkPVDataInformation::SetTimeLabel ( const char *  )
protectedvirtual

◆ SetCompositeDataClassName()

virtual void vtkPVDataInformation::SetCompositeDataClassName ( const char *  )
protectedvirtual

◆ SetCompositeDataSetName()

virtual void vtkPVDataInformation::SetCompositeDataSetName ( const char *  )
protectedvirtual

Friends And Related Function Documentation

◆ vtkPVDataInformationHelper

friend class vtkPVDataInformationHelper
friend

Definition at line 364 of file vtkPVDataInformation.h.

◆ vtkPVCompositeDataInformation

friend class vtkPVCompositeDataInformation
friend

Definition at line 365 of file vtkPVDataInformation.h.

Member Data Documentation

◆ DataSetType

int vtkPVDataInformation::DataSetType = -1
protected

Definition at line 320 of file vtkPVDataInformation.h.

◆ CompositeDataSetType

int vtkPVDataInformation::CompositeDataSetType = -1
protected

Definition at line 321 of file vtkPVDataInformation.h.

◆ NumberOfDataSets

int vtkPVDataInformation::NumberOfDataSets = 0
protected

Definition at line 322 of file vtkPVDataInformation.h.

◆ NumberOfPoints

vtkTypeInt64 vtkPVDataInformation::NumberOfPoints = 0
protected

Definition at line 323 of file vtkPVDataInformation.h.

◆ NumberOfCells

vtkTypeInt64 vtkPVDataInformation::NumberOfCells = 0
protected

Definition at line 324 of file vtkPVDataInformation.h.

◆ NumberOfRows

vtkTypeInt64 vtkPVDataInformation::NumberOfRows = 0
protected

Definition at line 325 of file vtkPVDataInformation.h.

◆ NumberOfTrees

vtkTypeInt64 vtkPVDataInformation::NumberOfTrees = 0
protected

Definition at line 326 of file vtkPVDataInformation.h.

◆ NumberOfVertices

vtkTypeInt64 vtkPVDataInformation::NumberOfVertices = 0
protected

Definition at line 327 of file vtkPVDataInformation.h.

◆ NumberOfEdges

vtkTypeInt64 vtkPVDataInformation::NumberOfEdges = 0
protected

Definition at line 328 of file vtkPVDataInformation.h.

◆ NumberOfLeaves

vtkTypeInt64 vtkPVDataInformation::NumberOfLeaves = 0
protected

Definition at line 329 of file vtkPVDataInformation.h.

◆ MemorySize

int vtkPVDataInformation::MemorySize = 0
protected

Definition at line 330 of file vtkPVDataInformation.h.

◆ PolygonCount

vtkIdType vtkPVDataInformation::PolygonCount = 0
protected

Definition at line 331 of file vtkPVDataInformation.h.

◆ Bounds

double vtkPVDataInformation::Bounds[6]
protected

◆ Extent

int vtkPVDataInformation::Extent[6]
protected
Initial value:

Definition at line 334 of file vtkPVDataInformation.h.

◆ TimeSpan

double vtkPVDataInformation::TimeSpan[2] = { VTK_DOUBLE_MAX, -VTK_DOUBLE_MAX }
protected

Definition at line 336 of file vtkPVDataInformation.h.

◆ Time

double vtkPVDataInformation::Time = 0.0
protected

Definition at line 337 of file vtkPVDataInformation.h.

◆ HasTime

int vtkPVDataInformation::HasTime = 0
protected

Definition at line 338 of file vtkPVDataInformation.h.

◆ NumberOfTimeSteps

int vtkPVDataInformation::NumberOfTimeSteps = 0
protected

Definition at line 339 of file vtkPVDataInformation.h.

◆ DataClassName

char* vtkPVDataInformation::DataClassName = nullptr
protected

Definition at line 341 of file vtkPVDataInformation.h.

◆ TimeLabel

char* vtkPVDataInformation::TimeLabel = nullptr
protected

Definition at line 344 of file vtkPVDataInformation.h.

◆ CompositeDataClassName

char* vtkPVDataInformation::CompositeDataClassName = nullptr
protected

Definition at line 347 of file vtkPVDataInformation.h.

◆ CompositeDataSetName

char* vtkPVDataInformation::CompositeDataSetName = nullptr
protected

Definition at line 350 of file vtkPVDataInformation.h.

◆ PointDataInformation

vtkPVDataSetAttributesInformation* vtkPVDataInformation::PointDataInformation
protected

Definition at line 351 of file vtkPVDataInformation.h.

◆ CellDataInformation

vtkPVDataSetAttributesInformation* vtkPVDataInformation::CellDataInformation
protected

Definition at line 354 of file vtkPVDataInformation.h.

◆ FieldDataInformation

vtkPVDataSetAttributesInformation* vtkPVDataInformation::FieldDataInformation
protected

Definition at line 355 of file vtkPVDataInformation.h.

◆ VertexDataInformation

vtkPVDataSetAttributesInformation* vtkPVDataInformation::VertexDataInformation
protected

Definition at line 356 of file vtkPVDataInformation.h.

◆ EdgeDataInformation

vtkPVDataSetAttributesInformation* vtkPVDataInformation::EdgeDataInformation
protected

Definition at line 357 of file vtkPVDataInformation.h.

◆ RowDataInformation

vtkPVDataSetAttributesInformation* vtkPVDataInformation::RowDataInformation
protected

Definition at line 358 of file vtkPVDataInformation.h.

◆ CompositeDataInformation

vtkPVCompositeDataInformation* vtkPVDataInformation::CompositeDataInformation
protected

Definition at line 360 of file vtkPVDataInformation.h.

◆ PointArrayInformation

vtkPVArrayInformation* vtkPVDataInformation::PointArrayInformation
protected

Definition at line 362 of file vtkPVDataInformation.h.


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