vtkSMLoadStateOptionsProxy.h

Go to the documentation of this file.

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

#include "vtkNew.h"                         // for vtkNew
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include "vtkSMProxy.h"

#include <vector> // needed for std::vector

class vtkSMSessionProxyManager;

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


  static bool PNGHasStateFile(const char* statefilename, std::string& contents,
    vtkTypeUInt32 location = 0x10 /*vtkPVSession::CLIENT*/);

  virtual bool PrepareToLoad(
    const char* statefilename, vtkTypeUInt32 location = 0x10 /*vtkPVSession::CLIENT*/);

  virtual bool HasDataFiles();

  virtual bool Load();

  enum
  {
    USE_FILES_FROM_STATE = 0,
    USE_DATA_DIRECTORY = 1,
    CHOOSE_FILES_EXPLICITLY = 2
  };

  vtkSMProperty* FindProperty(const char* name, int id, const char* pname);

  vtkSMProperty* FindLegacyProperty(const char* sanitizedName);

  bool IsPropertyModified(int id, const char* pname);

  std::string GetReaderName(int id) const;

protected:
  vtkSMLoadStateOptionsProxy();
  ~vtkSMLoadStateOptionsProxy() override;

  bool LocateFilesInDirectory(
    std::vector<std::string>& filepaths, int path, bool clearFilenameIfNotFound);

  vtkSetStringMacro(StateFileName);
  char* StateFileName;

  int DataFileOptions;

  int PathMatchingThreshold;

  bool OnlyUseFilesInDataDirectory;

private:
  class vtkInternals;
  vtkInternals* Internals;

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

#endif