vtkSMWriterFactory.h

Go to the documentation of this file.

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

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

class vtkPVXMLElement;
class vtkSMProxy;
class vtkSMSession;
class vtkSMSessionProxyManager;
class vtkSMSourceProxy;
class vtkStringList;

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

  void Initialize();

  void RegisterPrototype(const char* xmlgroup, const char* xmlname);

  bool CanWrite(vtkSMSourceProxy*, unsigned int outputport);

  vtkSMProxy* CreateWriter(
    const char* filename, vtkSMSourceProxy*, unsigned int outputport = 0, bool proxyname = false);

  vtkSMProxy* CreateWriter(
    const char* filename, vtkSMSourceProxy*, unsigned int outputport, const char* writerProxyName);

  std::string GetCorrectWriterName(const char* filename, vtkSMSourceProxy* source,
    unsigned int outputport, const char* writerProxyName);

  const char* GetSupportedFileTypes(vtkSMSourceProxy* source, unsigned int outputport);
  const char* GetSupportedFileTypes(vtkSMSourceProxy* source)
  {
    return this->GetSupportedFileTypes(source, 0);
  }


  vtkStringList* GetPossibleWriters(vtkSMSourceProxy* source, unsigned int outputport);
  const char* GetSupportedWriterProxies(vtkSMSourceProxy* source, unsigned int outputport);

  // Returns the number of registered prototypes.
  unsigned int GetNumberOfRegisteredPrototypes();

  void UpdateAvailableWriters();


  void AddGroup(const char* groupName);
  void RemoveGroup(const char* groupName);
  void GetGroups(vtkStringList* groups);

  static void AddWriterToWhitelist(const char* writerxmlgroup, const char* writerxmlname);

protected:
  vtkSMWriterFactory();
  ~vtkSMWriterFactory() override;

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

  class vtkInternals;
  vtkInternals* Internals;
};

#endif