/*=========================================================================

  Program:   ParaView
  Module:    vtkPVInputArrayRequirement.h
  Language:  C++
  Date:      $Date$
  Version:   $Revision$

Copyright (c) 2000-2001 Kitware Inc. 469 Clifton Corporate Parkway,
Clifton Park, NY, 12065, USA.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

 * Neither the name of Kitware nor the names of any contributors may be used
   to endorse or promote products derived from this software without specific 
   prior written permission.

 * Modified source versions must be plainly marked as such, and must not be
   misrepresented as being the original software.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

=========================================================================*/
// .NAME vtkPVInputArrayRequirement - Further restricts input by attributes.
// .SECTION Description
// Some filters should not accept inputs without specific attributes.
// An example is Contour requires point scalars.  This class holds
// the description of one attribute.  If you do not set one ivar,
// then it is not restricted:  i.e. Type not set means attribute
// can have any type.
// The vtkPVInput property is sort of an input restriction too 
// (excpet for name).  We might generalize and have boolean combiniations ... 

// Properties for UI (Properties Page) is an unfortunate KW naming convention.

#ifndef __vtkPVInputArrayRequirement_h
#define __vtkPVInputArrayRequirement_h


class vtkDataSet;
class vtkPVDataSetAttributesInformation;

#include "vtkPVInputRequirement.h"

class VTK_EXPORT vtkPVInputArrayRequirement : public vtkPVInputRequirement
{
public:
  static vtkPVInputArrayRequirement* New();
  vtkTypeRevisionMacro(vtkPVInputArrayRequirement, vtkPVInputRequirement);
  void PrintSelf(ostream& os, vtkIndent indent);
  
  // Description:
  // This method return 1 if the PVData matches the property.
  virtual int GetIsValidInput(vtkPVSource* input, vtkPVSource* pvs);

  // Description:
  // This are used by the field menu to determine is a field
  // should be selectable.
  virtual int GetIsValidField(int field, 
                              vtkPVDataSetAttributesInformation* info);

  // Description:
  // Called by vtkPVXMLPackageParser to configure the widget from XML
  // attributes.
  virtual int ReadXMLAttributes(vtkPVXMLElement* element,
                                vtkPVXMLPackageParser* parser);

  // Description:
  // Possible values are: 
  // vtkDataSet::POINT_DATA, vtkDataSet::CELL_DATA, vtkDataSet::DATA_OBJECT_FIELD
  // This method is only used for debugging.
  vtkGetMacro(Attribute,int);
  
  // Description:
  // Set the number of components.
  vtkSetMacro(NumberOfComponents,int);
  vtkGetMacro(NumberOfComponents,int);

  // Description:
  // Possible values are VTK_FLOAT, ....
  // This method is only used for debugging.
  vtkGetMacro(DataType,int);

protected:
  vtkPVInputArrayRequirement();
  ~vtkPVInputArrayRequirement() {};

  int Attribute;
  int DataType;
  int NumberOfComponents;

  int AttributeInfoContainsArray(vtkPVDataSetAttributesInformation* attrInfo);


  vtkPVInputArrayRequirement(const vtkPVInputArrayRequirement&); // Not implemented
  void operator=(const vtkPVInputArrayRequirement&); // Not implemented
};

#endif
