vtkPVProxyDefinitionIterator.h

Go to the documentation of this file.

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

  Program:   ParaView
  Module:    vtkPVProxyDefinitionIterator.h

  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 vtkPVProxyDefinitionIterator_h
#define vtkPVProxyDefinitionIterator_h

#include "vtkObject.h"
#include "vtkRemotingServerManagerModule.h" //needed for exports

class vtkPVXMLElement;

class VTKREMOTINGSERVERMANAGER_EXPORT vtkPVProxyDefinitionIterator : public vtkObject
{
public:
  vtkTypeMacro(vtkPVProxyDefinitionIterator, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  // ********* Iterator Common methods **********

  virtual void GoToFirstItem() = 0;

  virtual void InitTraversal() { this->GoToFirstItem(); }

  virtual void GoToNextItem() = 0;

  virtual void GoToNextGroup() = 0;

  virtual bool IsDoneWithTraversal() = 0;

  // ********* Configuration methods **********

  virtual void AddTraversalGroupName(const char* groupName) = 0;

  // ********* Access methods **********

  // Access methods
  virtual const char* GetGroupName() = 0;
  virtual const char* GetProxyName() = 0;
  virtual bool IsCustom() { return false; };
  virtual vtkPVXMLElement* GetProxyDefinition() = 0;
  virtual vtkPVXMLElement* GetProxyHints() = 0;

protected:
  vtkPVProxyDefinitionIterator();
  ~vtkPVProxyDefinitionIterator() override;

private:
  vtkPVProxyDefinitionIterator(const vtkPVProxyDefinitionIterator&) = delete;
  void operator=(const vtkPVProxyDefinitionIterator&) = delete;
};

#endif