vtkPVInputRequirement Class Reference

Restrict allowable input. More...

#include <vtkPVInputRequirement.h>

Inheritance diagram for vtkPVInputRequirement:

[legend]List of all members.

Public Member Functions
	vtkTypeRevisionMacro (vtkPVInputRequirement, vtkObject)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	GetIsValidInput (vtkPVSource *input, vtkPVSource *pvs)
virtual int	GetIsValidField (int field, vtkPVDataSetAttributesInformation *info)
virtual int	ReadXMLAttributes (vtkPVXMLElement *element, vtkPVXMLPackageParser *parser)
Static Public Member Functions
vtkPVInputRequirement *	New ()
Protected Member Functions
	vtkPVInputRequirement ()
	~vtkPVInputRequirement ()
	vtkPVInputRequirement (const vtkPVInputRequirement &)
void	operator= (const vtkPVInputRequirement &)

---

Detailed Description

Restrict allowable input.

Some filters should not accept inputs without specific attributes. An example is Contour requires point scalars. This is a supperclass for objects that describe input requirments. New subclasses can be added (and created through XML) for any crazy restriction.

Definition at line 35 of file vtkPVInputRequirement.h.

---

Constructor & Destructor Documentation

vtkPVInputRequirement::vtkPVInputRequirement (   )  [inline, protected]

Definition at line 62 of file vtkPVInputRequirement.h.

vtkPVInputRequirement::~vtkPVInputRequirement (   )  [inline, protected]

Definition at line 63 of file vtkPVInputRequirement.h.

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

---

Member Function Documentation

vtkPVInputRequirement* vtkPVInputRequirement::New (   )  [static]

Reimplemented in vtkPVInputArrayRequirement, vtkPVInputFixedTypeRequirement, and vtkPVInputGroupRequirement.

vtkPVInputRequirement::vtkTypeRevisionMacro (  vtkPVInputRequirement  , vtkObject  )

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

Reimplemented in vtkPVInputArrayRequirement, vtkPVInputFixedTypeRequirement, and vtkPVInputGroupRequirement.

virtual int vtkPVInputRequirement::GetIsValidInput (  vtkPVSource *  input, vtkPVSource *  pvs )  [virtual]

This method return 1 if the PVData matches the requirement. The pvSource pointer is only used by one requirement so far. vtkDataToDataSetFilters cannot change input types. Reimplemented in vtkPVInputArrayRequirement, vtkPVInputFixedTypeRequirement, and vtkPVInputGroupRequirement.

virtual int vtkPVInputRequirement::GetIsValidField (  int  field, vtkPVDataSetAttributesInformation *  info )  [virtual]

This are used by the field menu to determine is a field should be selectable. Reimplemented in vtkPVInputArrayRequirement.

virtual int vtkPVInputRequirement::ReadXMLAttributes (  vtkPVXMLElement *  element, vtkPVXMLPackageParser *  parser )  [virtual]

Called by vtkPVXMLPackageParser to configure the widget from XML attributes. Reimplemented in vtkPVInputArrayRequirement, vtkPVInputFixedTypeRequirement, and vtkPVInputGroupRequirement.

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

---

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

• GUI/Client/vtkPVInputRequirement.h

---