vtkPVDataInformation Class Reference

Light object for holding data information. More...

#include <vtkPVDataInformation.h>

Inheritance diagram for vtkPVDataInformation:

Collaboration diagram for vtkPVDataInformation:

List of all members.

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual void	CopyFromObject (vtkObject *)
virtual void	AddInformation (vtkPVInformation *info)
virtual void	AddInformation (vtkPVInformation *, int addingParts)
void	Initialize ()
const char *	GetPrettyDataTypeString ()
vtkPVDataSetAttributesInformation *	GetAttributeInformation (int fieldAssociation)
vtkPVDataInformation *	GetDataInformationForCompositeIndex (int index)
vtkPVDataInformation *	GetDataInformationForCompositeIndex (int *index)
virtual double *	GetTimeSpan ()
virtual void	GetTimeSpan (double &, double &)
virtual void	GetTimeSpan (double[2])
int	IsDataStructured ()
virtual void	SetPortNumber (int)
virtual int	GetPortNumber ()
virtual void	CopyToStream (vtkClientServerStream *)
virtual void	CopyFromStream (const vtkClientServerStream *)
virtual void	CopyParametersToStream (vtkMultiProcessStream &)
virtual void	CopyParametersFromStream (vtkMultiProcessStream &)
virtual int	GetDataSetType ()
virtual int	GetCompositeDataSetType ()
const char *	GetDataSetTypeAsString ()
int	DataSetTypeIsA (const char *type)
virtual vtkTypeInt64	GetNumberOfPoints ()
virtual vtkTypeInt64	GetNumberOfCells ()
virtual vtkTypeInt64	GetNumberOfRows ()
virtual int	GetMemorySize ()
virtual int	GetPolygonCount ()
virtual int	GetNumberOfDataSets ()
virtual double *	GetBounds ()
virtual void	GetBounds (double &, double &, double &, double &, double &, double &)
virtual void	GetBounds (double[6])
virtual int *	GetExtent ()
virtual void	GetExtent (int &, int &, int &, int &, int &, int &)
virtual void	GetExtent (int[6])
virtual vtkPVArrayInformation *	GetPointArrayInformation ()
virtual vtkPVDataSetAttributesInformation *	GetPointDataInformation ()
virtual vtkPVDataSetAttributesInformation *	GetCellDataInformation ()
virtual vtkPVDataSetAttributesInformation *	GetVertexDataInformation ()
virtual vtkPVDataSetAttributesInformation *	GetEdgeDataInformation ()
virtual vtkPVDataSetAttributesInformation *	GetRowDataInformation ()
virtual vtkPVDataSetAttributesInformation *	GetFieldDataInformation ()
virtual vtkPVCompositeDataInformation *	GetCompositeDataInformation ()
virtual char *	GetDataClassName ()
virtual char *	GetCompositeDataClassName ()
virtual int	GetHasTime ()
virtual double	GetTime ()
Static Public Member Functions
static vtkPVDataInformation *	New ()
static int	IsTypeOf (const char *type)
static vtkPVDataInformation *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPVDataInformation ()
	~vtkPVDataInformation ()
void	DeepCopy (vtkPVDataInformation *dataInfo, bool copyCompositeInformation=true)
void	AddFromMultiPieceDataSet (vtkCompositeDataSet *data)
void	CopyFromCompositeDataSet (vtkCompositeDataSet *data)
virtual void	CopyFromDataSet (vtkDataSet *data)
void	CopyFromGenericDataSet (vtkGenericDataSet *data)
void	CopyFromGraph (vtkGraph *graph)
void	CopyFromTable (vtkTable *table)
void	CopyFromSelection (vtkSelection *selection)
void	CopyCommonMetaData (vtkDataObject *, vtkInformation *)
virtual void	SetDataClassName (const char *)
virtual void	SetCompositeDataClassName (const char *)
Protected Attributes
int	DataSetType
int	CompositeDataSetType
int	NumberOfDataSets
vtkTypeInt64	NumberOfPoints
vtkTypeInt64	NumberOfCells
vtkTypeInt64	NumberOfRows
int	MemorySize
vtkIdType	PolygonCount
double	Bounds [6]
int	Extent [6]
double	TimeSpan [2]
double	Time
int	HasTime
char *	DataClassName
char *	CompositeDataClassName
vtkPVDataSetAttributesInformation *	PointDataInformation
vtkPVDataSetAttributesInformation *	CellDataInformation
vtkPVDataSetAttributesInformation *	FieldDataInformation
vtkPVDataSetAttributesInformation *	VertexDataInformation
vtkPVDataSetAttributesInformation *	EdgeDataInformation
vtkPVDataSetAttributesInformation *	RowDataInformation
vtkPVCompositeDataInformation *	CompositeDataInformation
vtkPVArrayInformation *	PointArrayInformation

---

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

---

Constructor & Destructor Documentation

vtkPVDataInformation::vtkPVDataInformation

(

)

[protected]

vtkPVDataInformation::~vtkPVDataInformation

(

)

[protected]

---

Member Function Documentation

static vtkPVDataInformation* vtkPVDataInformation::New

(

)

[static]

Reimplemented from vtkObject.

Reimplemented in vtkPVRepresentedDataInformation.

virtual const char* vtkPVDataInformation::GetClassName

(

)

[virtual]

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVRepresentedDataInformation.

static int vtkPVDataInformation::IsTypeOf

(

const char *

type

)

[static]

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVRepresentedDataInformation.

virtual int vtkPVDataInformation::IsA

(

const char *

type

)

[virtual]

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVRepresentedDataInformation.

static vtkPVDataInformation* vtkPVDataInformation::SafeDownCast

(

vtkObject *

o

)

[static]

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVRepresentedDataInformation.

void vtkPVDataInformation::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		[virtual]

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVRepresentedDataInformation.

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.

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.

virtual void vtkPVDataInformation::CopyFromObject

(

vtkObject *

)

[virtual]

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVRepresentedDataInformation.

virtual void vtkPVDataInformation::AddInformation

(

vtkPVInformation *

info

)

[virtual]

Merge another information object. Calls AddInformation(info, 0).

Reimplemented from vtkPVInformation.

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.

virtual void vtkPVDataInformation::CopyToStream

(

vtkClientServerStream *

)

[virtual]

Manage a serialized version of the information.

Implements vtkPVInformation.

virtual void vtkPVDataInformation::CopyFromStream

(

const vtkClientServerStream *

)

[virtual]

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

virtual void vtkPVDataInformation::CopyParametersToStream

(

vtkMultiProcessStream &

)

[virtual]

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.

virtual void vtkPVDataInformation::CopyParametersFromStream

(

vtkMultiProcessStream &

)

[virtual]

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.

void vtkPVDataInformation::Initialize

(

)

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

virtual int vtkPVDataInformation::GetDataSetType

(

)

[virtual]

Access to information.

virtual int vtkPVDataInformation::GetCompositeDataSetType

(

)

[virtual]

Access to information.

const char* vtkPVDataInformation::GetDataSetTypeAsString

(

)

Access to information.

int vtkPVDataInformation::DataSetTypeIsA

(

const char *

type

)

Access to information.

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfPoints

(

)

[virtual]

Access to information.

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfCells

(

)

[virtual]

Access to information.

virtual vtkTypeInt64 vtkPVDataInformation::GetNumberOfRows

(

)

[virtual]

Access to information.

virtual int vtkPVDataInformation::GetMemorySize

(

)

[virtual]

Access to information.

virtual int vtkPVDataInformation::GetPolygonCount

(

)

[virtual]

Access to information.

virtual int vtkPVDataInformation::GetNumberOfDataSets

(

)

[virtual]

Access to information.

virtual double* vtkPVDataInformation::GetBounds

(

)

[virtual]

Access to information.

virtual void vtkPVDataInformation::GetBounds	(	double &	,
		double &	,
		double &	,
		double &	,
		double &	,
		double &
	)		[virtual]

Access to information.

virtual void vtkPVDataInformation::GetBounds

(

double

[6]

)

[virtual]

Access to information.

const char* vtkPVDataInformation::GetPrettyDataTypeString

(

)

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

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.

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.

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.

virtual vtkPVArrayInformation* vtkPVDataInformation::GetPointArrayInformation

(

)

[virtual]

Access to information about points. Only valid for subclasses of vtkPointSet.

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetPointDataInformation

(

)

[virtual]

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

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetCellDataInformation

(

)

[virtual]

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

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetVertexDataInformation

(

)

[virtual]

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

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetEdgeDataInformation

(

)

[virtual]

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

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetRowDataInformation

(

)

[virtual]

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

virtual vtkPVDataSetAttributesInformation* vtkPVDataInformation::GetFieldDataInformation

(

)

[virtual]

Accesse to information about field data, if any.

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

virtual vtkPVCompositeDataInformation* vtkPVDataInformation::GetCompositeDataInformation

(

)

[virtual]

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

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.

vtkPVDataInformation* vtkPVDataInformation::GetDataInformationForCompositeIndex

(

int *

index

)

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

virtual char* vtkPVDataInformation::GetDataClassName

(

)

[virtual]

ClassName of the data represented by information object.

virtual char* vtkPVDataInformation::GetCompositeDataClassName

(

)

[virtual]

The least common class name of composite dataset blocks

virtual double* vtkPVDataInformation::GetTimeSpan

(

)

[virtual]

virtual void vtkPVDataInformation::GetTimeSpan	(	double &	,
		double &
	)		[virtual]

virtual void vtkPVDataInformation::GetTimeSpan

(

double

[2]

)

[virtual]

virtual int vtkPVDataInformation::GetHasTime

(

)

[virtual]

Returns if the Time is set.

virtual double vtkPVDataInformation::GetTime

(

)

[virtual]

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

int vtkPVDataInformation::IsDataStructured

(

)

Returns if the data type is structured.

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

void vtkPVDataInformation::AddFromMultiPieceDataSet

(

vtkCompositeDataSet *

data

)

[protected]

void vtkPVDataInformation::CopyFromCompositeDataSet

(

vtkCompositeDataSet *

data

)

[protected]

virtual void vtkPVDataInformation::CopyFromDataSet

(

vtkDataSet *

data

)

[protected, virtual]

void vtkPVDataInformation::CopyFromGenericDataSet

(

vtkGenericDataSet *

data

)

[protected]

void vtkPVDataInformation::CopyFromGraph

(

vtkGraph *

graph

)

[protected]

void vtkPVDataInformation::CopyFromTable

(

vtkTable *

table

)

[protected]

void vtkPVDataInformation::CopyFromSelection

(

vtkSelection *

selection

)

[protected]

void vtkPVDataInformation::CopyCommonMetaData	(	vtkDataObject *	,
		vtkInformation *
	)		[protected]

virtual void vtkPVDataInformation::SetDataClassName

(

const char *

)

[protected, virtual]

virtual void vtkPVDataInformation::SetCompositeDataClassName

(

const char *

)

[protected, virtual]

---

Member Data Documentation

int vtkPVDataInformation::DataSetType [protected]

Definition at line 200 of file vtkPVDataInformation.h.

int vtkPVDataInformation::CompositeDataSetType [protected]

Definition at line 201 of file vtkPVDataInformation.h.

int vtkPVDataInformation::NumberOfDataSets [protected]

Definition at line 202 of file vtkPVDataInformation.h.

vtkTypeInt64 vtkPVDataInformation::NumberOfPoints [protected]

Definition at line 203 of file vtkPVDataInformation.h.

vtkTypeInt64 vtkPVDataInformation::NumberOfCells [protected]

Definition at line 204 of file vtkPVDataInformation.h.

vtkTypeInt64 vtkPVDataInformation::NumberOfRows [protected]

Definition at line 205 of file vtkPVDataInformation.h.

int vtkPVDataInformation::MemorySize [protected]

Definition at line 206 of file vtkPVDataInformation.h.

vtkIdType vtkPVDataInformation::PolygonCount [protected]

Definition at line 207 of file vtkPVDataInformation.h.

double vtkPVDataInformation::Bounds[6] [protected]

Definition at line 208 of file vtkPVDataInformation.h.

int vtkPVDataInformation::Extent[6] [protected]

Definition at line 209 of file vtkPVDataInformation.h.

double vtkPVDataInformation::TimeSpan[2] [protected]

Definition at line 210 of file vtkPVDataInformation.h.

double vtkPVDataInformation::Time [protected]

Definition at line 211 of file vtkPVDataInformation.h.

int vtkPVDataInformation::HasTime [protected]

Definition at line 212 of file vtkPVDataInformation.h.

char* vtkPVDataInformation::DataClassName [protected]

Definition at line 214 of file vtkPVDataInformation.h.

char* vtkPVDataInformation::CompositeDataClassName [protected]

Definition at line 215 of file vtkPVDataInformation.h.

vtkPVDataSetAttributesInformation* vtkPVDataInformation::PointDataInformation [protected]

Definition at line 218 of file vtkPVDataInformation.h.

vtkPVDataSetAttributesInformation* vtkPVDataInformation::CellDataInformation [protected]

Definition at line 221 of file vtkPVDataInformation.h.

vtkPVDataSetAttributesInformation* vtkPVDataInformation::FieldDataInformation [protected]

Definition at line 222 of file vtkPVDataInformation.h.

vtkPVDataSetAttributesInformation* vtkPVDataInformation::VertexDataInformation [protected]

Definition at line 223 of file vtkPVDataInformation.h.

vtkPVDataSetAttributesInformation* vtkPVDataInformation::EdgeDataInformation [protected]

Definition at line 224 of file vtkPVDataInformation.h.

vtkPVDataSetAttributesInformation* vtkPVDataInformation::RowDataInformation [protected]

Definition at line 225 of file vtkPVDataInformation.h.

vtkPVCompositeDataInformation* vtkPVDataInformation::CompositeDataInformation [protected]

Definition at line 227 of file vtkPVDataInformation.h.

vtkPVArrayInformation* vtkPVDataInformation::PointArrayInformation [protected]

Definition at line 229 of file vtkPVDataInformation.h.

---

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

• dox/ParaViewCore/ClientServerCore/vtkPVDataInformation.h