vtkSMProxyConfigurationReader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMProxyConfigurationReader_h
#define vtkSMProxyConfigurationReader_h

#include "vtkRemotingMiscModule.h" //needed for exports
#include "vtkSMObject.h"

class vtkPVXMLElement;
class vtkSMProxy;

class VTKREMOTINGMISC_EXPORT vtkSMProxyConfigurationReader : public vtkSMObject
{
public:
  static vtkSMProxyConfigurationReader* New();
  vtkTypeMacro(vtkSMProxyConfigurationReader, vtkSMObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);


  virtual void SetProxy(vtkSMProxy* proxy);
  vtkGetObjectMacro(Proxy, vtkSMProxy);


  vtkSetStringMacro(FileIdentifier);
  vtkGetStringMacro(FileIdentifier);

  vtkSetStringMacro(FileDescription);
  vtkGetStringMacro(FileDescription);

  vtkSetStringMacro(FileExtension);
  vtkGetStringMacro(FileExtension);


  vtkSetMacro(ValidateProxyType, int);
  vtkGetMacro(ValidateProxyType, int);

  virtual const char* GetReaderVersion() { return "1.0"; }

  virtual bool CanReadVersion(const char* version);


  virtual int ReadConfiguration();
  virtual int ReadConfiguration(const char* filename);

  virtual int ReadConfiguration(vtkPVXMLElement* xmlStream);

protected:
  vtkSMProxyConfigurationReader();
  ~vtkSMProxyConfigurationReader() override;

private:
  char* FileName;
  int ValidateProxyType;
  //-------------------
  vtkSMProxy* Proxy;
  //-------------------
  char* FileIdentifier;
  char* FileDescription;
  char* FileExtension;

  vtkSMProxyConfigurationReader(const vtkSMProxyConfigurationReader&) = delete;
  void operator=(const vtkSMProxyConfigurationReader&) = delete;
};

#endif