Servers/ServerManager/vtkSMDomain.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    $RCSfile: vtkSMDomain.h,v $

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef __vtkSMDomain_h
#define __vtkSMDomain_h

#include "vtkSMObject.h"
#include "vtkClientServerID.h" // needed for saving animation in batch script

class vtkSMProperty;
class vtkPVXMLElement;
//BTX
struct vtkSMDomainInternals;
//ETX

class VTK_EXPORT vtkSMDomain : public vtkSMObject
{
public:
  vtkTypeRevisionMacro(vtkSMDomain, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent);

  virtual int IsInDomain(vtkSMProperty* property) = 0;

  virtual void Update(vtkSMProperty*) {this->InvokeModified();};

  virtual void SetAnimationValue(vtkSMProperty*, int, double) {}


  vtkGetStringMacro(XMLName);

  void AddRequiredProperty(vtkSMProperty *prop, const char *function);

protected:
  vtkSMDomain();
  ~vtkSMDomain();

//BTX
  friend class vtkSMProperty;
//ETX

  vtkSMProperty* GetRequiredProperty(const char* function);

  void RemoveRequiredProperty(vtkSMProperty* prop);

  virtual int ReadXMLAttributes(vtkSMProperty* prop, vtkPVXMLElement* elem);


  vtkSetMacro(IsOptional, int);
  vtkGetMacro(IsOptional, int);
  int IsOptional;

  char* XMLName;


  vtkSetStringMacro(XMLName);

  vtkSMDomainInternals* Internals;

  void InvokeModified();

private:
  vtkSMDomain(const vtkSMDomain&); // Not implemented
  void operator=(const vtkSMDomain&); // Not implemented
};

#endif

---