Data array information like type. More...

#include <vtkPVArrayInformation.h>

Inheritance diagram for vtkPVArrayInformation:

Collaboration diagram for vtkPVArrayInformation:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
void	SetComponentName (vtkIdType component, const char *name)
const char *	GetComponentName (vtkIdType component)
void	GetDataTypeRange (double range[2])
int	Compare (vtkPVArrayInformation *info)
void	AddRanges (vtkPVArrayInformation *info)
void	DeepCopy (vtkPVArrayInformation *info)
virtual void	CopyFromObject (vtkObject *)
virtual void	AddInformation (vtkPVInformation *)
void	Initialize ()

virtual void	SetDataType (int)
virtual int	GetDataType ()

virtual void	SetName (const char *)
virtual char *	GetName ()

void	SetNumberOfComponents (int numComps)
virtual int	GetNumberOfComponents ()

virtual void	SetNumberOfTuples (int)
virtual int	GetNumberOfTuples ()

void	SetComponentRange (int comp, double min, double max)
void	SetComponentRange (int comp, double *range)
double *	GetComponentRange (int component)
void	GetComponentRange (int comp, double *range)

virtual void	CopyToStream (vtkClientServerStream *)
virtual void	CopyFromStream (const vtkClientServerStream *)

virtual void	SetIsPartial (int)
virtual int	GetIsPartial ()

void	AddInformationKeys (vtkPVArrayInformation *info)
void	AddInformationKey (const char location, const char name)
void	AddUniqueInformationKey (const char location, const char name)

int	GetNumberOfInformationKeys ()
const char *	GetInformationKeyLocation (int)
const char *	GetInformationKeyName (int)
int	HasInformationKey (const char location, const char name)
Static Public Member Functions
static vtkPVArrayInformation *	New ()
static int	IsTypeOf (const char *type)
static vtkPVArrayInformation *	SafeDownCast (vtkObject *o)
Protected Member Functions
	vtkPVArrayInformation ()
	~vtkPVArrayInformation ()
void	DetermineDefaultComponentName (const int &component_no, const int &numComps)
	assigns to a string to DefaultComponentName for this component
	vtkPVArrayInformation (const vtkPVArrayInformation &)
void	operator= (const vtkPVArrayInformation &)
Protected Attributes
int	IsPartial
int	DataType
int	NumberOfComponents
int	NumberOfTuples
char *	Name
double *	Ranges
vtkInternalInformationKeys *	InformationKeys
vtkStdString *	DefaultComponentName
vtkInternalComponentNames *	ComponentNames

Detailed Description

Data array information like type.

This objects is for eliminating direct access to vtkDataObjects by the "client". Only vtkPVPart and vtkPVProcessModule should access the data directly. At the moment, this object is only a container and has no useful methods for operating on data. Note: I could just use vtkDataArray objects and store the range as values in the array. This would eliminate this object.

Definition at line 34 of file vtkPVArrayInformation.h.

Constructor & Destructor Documentation

vtkPVArrayInformation::vtkPVArrayInformation ( ) [protected]

vtkPVArrayInformation::~vtkPVArrayInformation ( ) [protected]

vtkPVArrayInformation::vtkPVArrayInformation ( const vtkPVArrayInformation & ) [protected]

Member Function Documentation

static vtkPVArrayInformation* vtkPVArrayInformation::New ( ) [static]

Reimplemented from vtkObject.

Reimplemented in vtkPVGenericAttributeInformation.

virtual const char* vtkPVArrayInformation::GetClassName ( ) [virtual]

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVGenericAttributeInformation.

static int vtkPVArrayInformation::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVGenericAttributeInformation.

virtual int vtkPVArrayInformation::IsA ( const char * type ) [virtual]

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVGenericAttributeInformation.

static vtkPVArrayInformation* vtkPVArrayInformation::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVGenericAttributeInformation.

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

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVGenericAttributeInformation.

virtual void vtkPVArrayInformation::SetDataType ( int ) [virtual]

DataType is the string name of the data type: VTK_FLOAT ... the value "VTK_VOID" means that different processes have different types.

virtual int vtkPVArrayInformation::GetDataType ( ) [virtual]

DataType is the string name of the data type: VTK_FLOAT ... the value "VTK_VOID" means that different processes have different types.

virtual void vtkPVArrayInformation::SetName ( const char * ) [virtual]

Set/get array's name

virtual char* vtkPVArrayInformation::GetName ( ) [virtual]

Set/get array's name

void vtkPVArrayInformation::SetNumberOfComponents ( int numComps )

Changing the number of components clears the ranges back to the default.

virtual int vtkPVArrayInformation::GetNumberOfComponents ( ) [virtual]

Changing the number of components clears the ranges back to the default.

void vtkPVArrayInformation::SetComponentName	(	vtkIdType	component,
		const char *	name
	)

Set the name for a component. Must be >= 1.

const char* vtkPVArrayInformation::GetComponentName ( vtkIdType component )

Get the component name for a given component. Note: the const char* that is returned is only valid intill the next call to this method!

virtual void vtkPVArrayInformation::SetNumberOfTuples ( int ) [virtual]

Set/get the array's length

virtual int vtkPVArrayInformation::GetNumberOfTuples ( ) [virtual]

Set/get the array's length

void vtkPVArrayInformation::SetComponentRange	(	int	comp,
		double	min,
		double	max
	)

There is a range for each component. Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

void vtkPVArrayInformation::SetComponentRange	(	int	comp,
		double *	range
	)		`[inline]`

There is a range for each component. Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

Definition at line 79 of file vtkPVArrayInformation.h.

double* vtkPVArrayInformation::GetComponentRange ( int component )

There is a range for each component. Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

void vtkPVArrayInformation::GetComponentRange	(	int	comp,
		double *	range
	)

There is a range for each component. Range for component -1 is the range of the vector magnitude. The number of components should be set before these ranges.

void vtkPVArrayInformation::GetDataTypeRange ( double range[2] )

This method return the Min and Max possible range of the native data type. For example if a vtkScalars consists of unsigned char data these will return (0,255). Nothing particular for 12bits data is done

int vtkPVArrayInformation::Compare ( vtkPVArrayInformation * info )

Returns 1 if the array can be combined. It must have the same name and number of components.

void vtkPVArrayInformation::AddRanges ( vtkPVArrayInformation * info )

Merge (union) ranges into this object.

void vtkPVArrayInformation::DeepCopy ( vtkPVArrayInformation * info )

virtual void vtkPVArrayInformation::CopyFromObject ( vtkObject * ) [virtual]

Transfer information about a single object into this object.

Reimplemented from vtkPVInformation.

Reimplemented in vtkPVGenericAttributeInformation.

virtual void vtkPVArrayInformation::AddInformation ( vtkPVInformation * ) [virtual]

Merge another information object.

Reimplemented from vtkPVInformation.

virtual void vtkPVArrayInformation::CopyToStream ( vtkClientServerStream * ) [virtual]

Manage a serialized version of the information.

Implements vtkPVInformation.

virtual void vtkPVArrayInformation::CopyFromStream ( const vtkClientServerStream * ) [virtual]

Manage a serialized version of the information.

Reimplemented from vtkPVInformation.

virtual void vtkPVArrayInformation::SetIsPartial ( int ) [virtual]

If IsPartial is true, this array is in only some of the parts of a multi-block dataset. By default, IsPartial is set to 0.

virtual int vtkPVArrayInformation::GetIsPartial ( ) [virtual]

If IsPartial is true, this array is in only some of the parts of a multi-block dataset. By default, IsPartial is set to 0.

void vtkPVArrayInformation::Initialize ( )

Remove all infommation. Next add will be like a copy.

void vtkPVArrayInformation::AddInformationKeys ( vtkPVArrayInformation * info )

Merge (union) keys into this object.

void vtkPVArrayInformation::AddInformationKey	(	const char *	location,
		const char *	name
	)

Merge (union) keys into this object.

void vtkPVArrayInformation::AddUniqueInformationKey	(	const char *	location,
		const char *	name
	)

Merge (union) keys into this object.

int vtkPVArrayInformation::GetNumberOfInformationKeys ( )

Get information on the InformationKeys of this array

const char* vtkPVArrayInformation::GetInformationKeyLocation ( int )

Get information on the InformationKeys of this array

const char* vtkPVArrayInformation::GetInformationKeyName ( int )

Get information on the InformationKeys of this array

int vtkPVArrayInformation::HasInformationKey	(	const char *	location,
		const char *	name
	)

Get information on the InformationKeys of this array

void vtkPVArrayInformation::DetermineDefaultComponentName	(	const int &	component_no,
		const int &	numComps
	)		`[protected]`

assigns to a string to DefaultComponentName for this component

void vtkPVArrayInformation::operator= ( const vtkPVArrayInformation & ) [protected]

Member Data Documentation

int vtkPVArrayInformation::IsPartial [protected]

Definition at line 140 of file vtkPVArrayInformation.h.

int vtkPVArrayInformation::DataType [protected]

Definition at line 141 of file vtkPVArrayInformation.h.

int vtkPVArrayInformation::NumberOfComponents [protected]

Definition at line 142 of file vtkPVArrayInformation.h.

int vtkPVArrayInformation::NumberOfTuples [protected]

Definition at line 143 of file vtkPVArrayInformation.h.

char* vtkPVArrayInformation::Name [protected]

Definition at line 144 of file vtkPVArrayInformation.h.

double* vtkPVArrayInformation::Ranges [protected]

Definition at line 145 of file vtkPVArrayInformation.h.

vtkInternalInformationKeys* vtkPVArrayInformation::InformationKeys [protected]

Definition at line 149 of file vtkPVArrayInformation.h.

vtkStdString* vtkPVArrayInformation::DefaultComponentName [protected]

Definition at line 155 of file vtkPVArrayInformation.h.

vtkInternalComponentNames* vtkPVArrayInformation::ComponentNames [protected]

Definition at line 162 of file vtkPVArrayInformation.h.

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

dox/ParaViewCore/ClientServerCore/vtkPVArrayInformation.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation