vtkPVDataSetAttributesInformation Class Reference

List of array info. More...

#include <vtkPVDataSetAttributesInformation.h>

Inheritance diagram for vtkPVDataSetAttributesInformation:

Collaboration diagram for vtkPVDataSetAttributesInformation:

Classes
class	AlphabeticalArrayInformationIterator
	Iterator over a vtkPVDataSetAttributesInformation's arrays; yielding their vtkPVArrayInformation. More...

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent) override
void	Initialize ()
	Initialize this instances to its default state. More...
int	GetNumberOfArrays () const
	Returns the number of array informations available in this instance. More...
int	GetMaximumNumberOfTuples () const
	Returns the maximum number of tuples in all known arrays. More...
vtkPVArrayInformation *	GetAttributeInformation (int attributeType)
	Returns array information for an array associated with a specific attribute type. More...
int	IsArrayAnAttribute (int arrayIndex)
	Returns the attribute type if at the array at the given index is an attribute. More...
AlphabeticalArrayInformationIterator *	NewAlphabeticalArrayInformationIterator ()
	Returns a new iterator to traverse array informations alphabetically. More...
virtual int	GetFieldAssociation ()
	Returns the field association to which the instance corresponds to. More...
virtual char *	GetFieldName ()
	Returns the field association to which the instance corresponds to. More...
vtkPVArrayInformation *	GetArrayInformation (int idx) const
	Returns array information for the chosen array either by name or by index. More...
vtkPVArrayInformation *	GetArrayInformation (const char *name) const
	Returns array information for the chosen array either by name or by index. 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 vtkPVDataSetAttributesInformation *	New ()
static int	IsTypeOf (const char *type)
static vtkPVDataSetAttributesInformation *	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
	vtkPVDataSetAttributesInformation ()
	~vtkPVDataSetAttributesInformation () override
void	AddInformation (vtkPVDataSetAttributesInformation *)
	Combine with another vtkPVDataSetAttributesInformation instance. More...
void	DeepCopy (vtkPVDataSetAttributesInformation *)
	Copies from another vtkPVDataSetAttributesInformation instance. More...
void	CopyFromDataObject (vtkDataObject *dobj)
	Initializes this instance using the data object. More...
void	MarkArraysAsGlobal ()
	Marks all arrays in this instance as global (i.e., from the root node of a composite dataset). More...
virtual void	SetFieldAssociation (int)
	Set field association and name. More...
virtual void	SetFieldName (const char *)
	Set field association and name. More...
void	CopyToStream (vtkClientServerStream *)
	Manage a serialized version of the information. More...
void	CopyFromStream (const vtkClientServerStream *)
	Manage a serialized version of the information. More...
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	vtkPVDataInformation
class	vtkPVDataInformationAccumulator

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers

Detailed Description

List of array info.

Information associated with vtkDataSetAttributes object (i.e point data). This object does not have any user interface. It is created and destroyed on the fly as needed. It may be possible to add features of this object to vtkDataSetAttributes. That would eliminate all of the "Information" in ParaView.

Definition at line 27 of file vtkPVDataSetAttributesInformation.h.

Member Typedef Documentation

Superclass

typedef vtkObject vtkPVDataSetAttributesInformation::Superclass

Definition at line 53 of file vtkPVDataSetAttributesInformation.h.

Constructor & Destructor Documentation

vtkPVDataSetAttributesInformation()

vtkPVDataSetAttributesInformation::vtkPVDataSetAttributesInformation ( )

protected

~vtkPVDataSetAttributesInformation()

vtkPVDataSetAttributesInformation::~vtkPVDataSetAttributesInformation ( )

overrideprotected

Member Function Documentation

New()

static vtkPVDataSetAttributesInformation* vtkPVDataSetAttributesInformation::New ( )

static

GetClassName()

virtual const char* vtkPVDataSetAttributesInformation::GetClassName ( )

virtual

IsTypeOf()

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

static

IsA()

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

virtual

Reimplemented from vtkObjectBase.

SafeDownCast()

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

static

PrintSelf()

void vtkPVDataSetAttributesInformation::PrintSelf ( ostream &  os, vtkIndent  indent  )

overridevirtual

Reimplemented from vtkObject.

GetFieldAssociation()

virtual int vtkPVDataSetAttributesInformation::GetFieldAssociation ( )

virtual

Returns the field association to which the instance corresponds to.

Returned value can be vtkDataObject::POINT, vtkDataObject::CELL, vtkDataObject::FIELD, etc i.e. vtkDataObject::FieldAssociations or vtkDataObject::AttributeTypes.

For vtkCellGrid, this can be the hash value of the string token of each attribute.

GetFieldName()

virtual char* vtkPVDataSetAttributesInformation::GetFieldName ( )

virtual

Returns the field association to which the instance corresponds to.

Returned value can be vtkDataObject::POINT, vtkDataObject::CELL, vtkDataObject::FIELD, etc i.e. vtkDataObject::FieldAssociations or vtkDataObject::AttributeTypes.

For vtkCellGrid, this can be the hash value of the string token of each attribute.

Initialize()

void vtkPVDataSetAttributesInformation::Initialize

(

)

Initialize this instances to its default state.

GetNumberOfArrays()

int vtkPVDataSetAttributesInformation::GetNumberOfArrays

(

)

const

Returns the number of array informations available in this instance.

GetMaximumNumberOfTuples()

int vtkPVDataSetAttributesInformation::GetMaximumNumberOfTuples

(

)

const

Returns the maximum number of tuples in all known arrays.

GetArrayInformation() [1/2]

vtkPVArrayInformation* vtkPVDataSetAttributesInformation::GetArrayInformation

(

int

idx

)

const

Returns array information for the chosen array either by name or by index.

Note that the index overload is significantly is faster.

GetArrayInformation() [2/2]

vtkPVArrayInformation* vtkPVDataSetAttributesInformation::GetArrayInformation

(

const char *

name

)

const

Returns array information for the chosen array either by name or by index.

Note that the index overload is significantly is faster.

GetAttributeInformation()

vtkPVArrayInformation* vtkPVDataSetAttributesInformation::GetAttributeInformation

(

int

attributeType

)

Returns array information for an array associated with a specific attribute type.

Supported attribute types are vtkDataSetAttributes::AttributeTypes.

IsArrayAnAttribute()

int vtkPVDataSetAttributesInformation::IsArrayAnAttribute

(

int

arrayIndex

)

Returns the attribute type if at the array at the given index is an attribute.

NewAlphabeticalArrayInformationIterator()

AlphabeticalArrayInformationIterator* vtkPVDataSetAttributesInformation::NewAlphabeticalArrayInformationIterator

(

)

Returns a new iterator to traverse array informations alphabetically.

This approach is noticeably slower than looping over array indices. Prefer doing so unless you explicitely need the ordered arrays. Caller is responsible for releasing the iterator memory.

SetFieldAssociation()

virtual void vtkPVDataSetAttributesInformation::SetFieldAssociation ( int  )

protectedvirtual

Set field association and name.

SetFieldName()

virtual void vtkPVDataSetAttributesInformation::SetFieldName ( const char *  )

protectedvirtual

Set field association and name.

CopyToStream()

void vtkPVDataSetAttributesInformation::CopyToStream ( vtkClientServerStream *  )

protected

Manage a serialized version of the information.

CopyFromStream()

void vtkPVDataSetAttributesInformation::CopyFromStream ( const vtkClientServerStream *  )

protected

Manage a serialized version of the information.

AddInformation()

void vtkPVDataSetAttributesInformation::AddInformation ( vtkPVDataSetAttributesInformation *  )

protected

Combine with another vtkPVDataSetAttributesInformation instance.

DeepCopy()

void vtkPVDataSetAttributesInformation::DeepCopy ( vtkPVDataSetAttributesInformation *  )

protected

Copies from another vtkPVDataSetAttributesInformation instance.

CopyFromDataObject()

void vtkPVDataSetAttributesInformation::CopyFromDataObject ( vtkDataObject *  dobj )

protected

Initializes this instance using the data object.

MarkArraysAsGlobal()

void vtkPVDataSetAttributesInformation::MarkArraysAsGlobal ( )

protected

Marks all arrays in this instance as global (i.e., from the root node of a composite dataset).

Must be called after CopyFromDataObject.

Friends And Related Function Documentation

vtkPVDataInformation

friend class vtkPVDataInformation

friend

Definition at line 117 of file vtkPVDataSetAttributesInformation.h.

vtkPVDataInformationAccumulator

friend class vtkPVDataInformationAccumulator

friend

Definition at line 118 of file vtkPVDataSetAttributesInformation.h.

---

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

• /builds/gitlab-kitware-sciviz-ci/Remoting/Core/vtkPVDataSetAttributesInformation.h