vtkSMProxyConfigurationWriter.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Kitware Inc.
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkSMProxyConfigurationWriter_h
#define vtkSMProxyConfigurationWriter_h

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

class vtkSMPropertyIterator;
class vtkSMProxy;
class vtkStringList;

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


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


  virtual void SetPropertyIterator(vtkSMPropertyIterator* iter);
  vtkGetObjectMacro(PropertyIterator, vtkSMPropertyIterator);


  vtkSetStringMacro(FileName);
  vtkGetStringMacro(FileName);


  vtkSetStringMacro(FileIdentifier);
  vtkGetStringMacro(FileIdentifier);

  vtkSetStringMacro(FileDescription);
  vtkGetStringMacro(FileDescription);

  vtkSetStringMacro(FileExtension);
  vtkGetStringMacro(FileExtension);

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


  virtual int WriteConfiguration();
  virtual int WriteConfiguration(const char* fileName);

  virtual int WriteConfiguration(ostream& os);

protected:
  vtkSMProxyConfigurationWriter();
  ~vtkSMProxyConfigurationWriter() override;

private:
  vtkSMProxyConfigurationWriter(const vtkSMProxyConfigurationWriter&) = delete;
  void operator=(const vtkSMProxyConfigurationWriter&) = delete;

  char* FileName;
  //-------------------
  vtkSMProxy* Proxy;
  vtkSMPropertyIterator* PropertyIterator;
  //-------------------
  char* FileIdentifier;
  char* FileDescription;
  char* FileExtension;
};

#endif