vtkSMInputArrayDomain Class Reference

requires input has array of described type More...

#include <vtkSMInputArrayDomain.h>

Inheritance diagram for vtkSMInputArrayDomain:

[legend]Collaboration diagram for vtkSMInputArrayDomain:

[legend]List of all members.

Public Types
enum	AttributeTypes { POINT = 0, CELL = 1, ANY = 2, LAST_ATTRIBUTE_TYPE }
Public Member Functions
	vtkTypeRevisionMacro (vtkSMInputArrayDomain, vtkSMDomain)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	IsInDomain (vtkSMProperty *property)
int	IsInDomain (vtkSMSourceProxy *proxy)
int	IsFieldValid (vtkSMSourceProxy *proxy, vtkPVArrayInformation *arrayInfo)
int	IsFieldValid (vtkSMSourceProxy *proxy, vtkPVArrayInformation *arrayInfo, int bypass)
virtual void	SetAttributeType (unsigned char)
virtual unsigned char	GetAttributeType ()
const char *	GetAttributeTypeAsString ()
virtual void	SetAttributeType (const char *type)
virtual void	SetNumberOfComponents (int)
virtual int	GetNumberOfComponents ()
Static Public Member Functions
vtkSMInputArrayDomain *	New ()
Protected Member Functions
	vtkSMInputArrayDomain ()
	~vtkSMInputArrayDomain ()
virtual int	ReadXMLAttributes (vtkSMProperty *prop, vtkPVXMLElement *element)
virtual void	SaveState (const char *name, ostream *file, vtkIndent indent)
int	AttributeInfoContainsArray (vtkSMSourceProxy *proxy, vtkPVDataSetAttributesInformation *attrInfo)
int	CheckForArray (vtkPVArrayInformation *arrayInfo, vtkPVDataSetAttributesInformation *attrInfo)
Protected Attributes
unsigned char	AttributeType
int	NumberOfComponents

---

Detailed Description

requires input has array of described type

vtkSMInputArrayDomain requires that the source proxy pointed by the property has an output with one or more arrays of specified type. Current restrictions include whether the array is part of point or cell data and whether it has a given number of components. These are specified in the XML file. Valid XML attributes are:

 * attribute_type - cell or point
 * number_of_components
 

The attribute type can also be (optionally) obtained from a required property FieldDataSelection which has a value of vtkDataSet::POINT_DATA_FIELD or vtkDataSet::CELL_DATA_FIELD.

See also:

vtkSMDomain

Definition at line 43 of file vtkSMInputArrayDomain.h.

---

Member Enumeration Documentation

enum vtkSMInputArrayDomain::AttributeTypes

Enumeration values: POINT  CELL  ANY  LAST_ATTRIBUTE_TYPE  Definition at line 85 of file vtkSMInputArrayDomain.h.

---

Constructor & Destructor Documentation

vtkSMInputArrayDomain::vtkSMInputArrayDomain (   )  [protected]

vtkSMInputArrayDomain::~vtkSMInputArrayDomain (   )  [protected]

---

Member Function Documentation

vtkSMInputArrayDomain* vtkSMInputArrayDomain::New (   )  [static]

Reimplemented from vtkSMObject.

vtkSMInputArrayDomain::vtkTypeRevisionMacro (  vtkSMInputArrayDomain  , vtkSMDomain  )

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

Reimplemented from vtkSMDomain.

virtual int vtkSMInputArrayDomain::IsInDomain (  vtkSMProperty *  property  )  [virtual]

Returns true if the value of the propery is in the domain. The propery has to be a vtkSMProxyProperty which points to a vtkSMSourceProxy. The input has to have one or more arrays that match the requirements. Implements vtkSMDomain.

int vtkSMInputArrayDomain::IsInDomain (  vtkSMSourceProxy *  proxy  )

Returns true if input has one or more arrays that match the requirements.

int vtkSMInputArrayDomain::IsFieldValid (  vtkSMSourceProxy *  proxy, vtkPVArrayInformation *  arrayInfo )

Returns 1 if the array represented by the array information is a valid field. The attribute type (point or cell) as well as the number of components are checked for a match

int vtkSMInputArrayDomain::IsFieldValid (  vtkSMSourceProxy *  proxy, vtkPVArrayInformation *  arrayInfo, int  bypass )

Returns 1 if the array represented by the array information is a valid field. The attribute type (point or cell) as well as the number of components are checked for a match

virtual void vtkSMInputArrayDomain::SetAttributeType (  unsigned  char  )  [virtual]

Set/get the attribute type. Valid values are: POINT, CELL, ANY. Text representations are: point, cell, any.

virtual unsigned char vtkSMInputArrayDomain::GetAttributeType (   )  [virtual]

Set/get the attribute type. Valid values are: POINT, CELL, ANY. Text representations are: point, cell, any.

const char* vtkSMInputArrayDomain::GetAttributeTypeAsString (   )

Set/get the attribute type. Valid values are: POINT, CELL, ANY. Text representations are: point, cell, any.

virtual void vtkSMInputArrayDomain::SetAttributeType (  const char *  type  )  [virtual]

Set/get the attribute type. Valid values are: POINT, CELL, ANY. Text representations are: point, cell, any.

virtual void vtkSMInputArrayDomain::SetNumberOfComponents (  int   )  [virtual]

Set/get the required number of components. Set to 0 for no check.

virtual int vtkSMInputArrayDomain::GetNumberOfComponents (   )  [virtual]

Set/get the required number of components. Set to 0 for no check.

virtual int vtkSMInputArrayDomain::ReadXMLAttributes (  vtkSMProperty *  prop, vtkPVXMLElement *  element )  [protected, virtual]

Set the appropriate ivars from the xml element. Should be overwritten by subclass if adding ivars. Reimplemented from vtkSMDomain.

virtual void vtkSMInputArrayDomain::SaveState (  const char *  name, ostream *  file, vtkIndent  indent )  [protected, virtual]

Saves the state of the object in XML format. Should be overwritten by proxies and properties. Reimplemented from vtkSMObject.

int vtkSMInputArrayDomain::AttributeInfoContainsArray (  vtkSMSourceProxy *  proxy, vtkPVDataSetAttributesInformation *  attrInfo )  [protected]

int vtkSMInputArrayDomain::CheckForArray (  vtkPVArrayInformation *  arrayInfo, vtkPVDataSetAttributesInformation *  attrInfo )  [protected]

---

Member Data Documentation

unsigned char vtkSMInputArrayDomain::AttributeType [protected]

Definition at line 109 of file vtkSMInputArrayDomain.h.

int vtkSMInputArrayDomain::NumberOfComponents [protected]

Definition at line 110 of file vtkSMInputArrayDomain.h.

---

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

• Servers/ServerManager/vtkSMInputArrayDomain.h

---