vtkSMSettings.h

Go to the documentation of this file.

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

#include "vtkObject.h"
#include "vtkRemotingServerManagerModule.h" //needed for exports
#include <vector>                           // needed for vector.
#include <vtk_jsoncpp_fwd.h>                // for forward declarations

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

  static vtkSMSettings* GetInstance();

  bool AddCollectionFromString(const std::string& settings, double priority);

  bool AddCollectionFromFile(const std::string& fileName, double priority);

  void ClearAllSettings();

  bool DistributeSettings();

  bool SaveSettingsToFile(const std::string& filePath);

  bool SaveSettingsToFile(const std::string& filePath, double priority);

  bool HasSetting(const char* settingName);

  bool HasSetting(const char* settingName, double maxPriority);

  unsigned int GetSettingNumberOfElements(const char* settingName);


  int GetSettingAsInt(const char* settingName, int defaultValue);
  double GetSettingAsDouble(const char* settingName, double defaultValue);
  std::string GetSettingAsString(const char* settingName, const std::string& defaultValue);


  int GetSettingAsInt(const char* settingName, unsigned int index, int defaultValue);
  double GetSettingAsDouble(const char* settingName, unsigned int index, double defaultValue);
  std::string GetSettingAsString(
    const char* settingName, unsigned int index, const std::string& defaultValue);

  bool GetPropertySetting(vtkSMProperty* property);

  bool GetPropertySetting(vtkSMProperty* property, double maxPriority);

  bool GetPropertySetting(const char* prefix, vtkSMProperty* property);

  bool GetPropertySetting(const char* prefix, vtkSMProperty* property, double maxPriority);

  bool GetProxySettings(vtkSMProxy* proxy);

  bool GetProxySettings(vtkSMProxy* proxy, double maxPriority);

  bool GetProxySettings(const char* prefix, vtkSMProxy* proxy);

  bool GetProxySettings(const char* prefix, vtkSMProxy* proxy, double maxPriority);
  ;

  std::string GetSettingDescription(const char* settingName);


  void SetSetting(const char* settingName, int value);
  void SetSetting(const char* settingName, double value);
  void SetSetting(const char* settingName, const std::string& value);


  void SetSetting(const char* settingName, unsigned int index, int value);
  void SetSetting(const char* settingName, unsigned int index, double value);
  void SetSetting(const char* settingName, unsigned int index, const std::string& value);

  void SetProxySettings(vtkSMProxy* proxy, vtkSMPropertyIterator* propertyIt = nullptr,
    bool skipPropertiesWithDynamicDomains = true);

  void SetProxySettings(const char* prefix, vtkSMProxy* proxy,
    vtkSMPropertyIterator* propertyIt = nullptr, bool skipPropertiesWithDynamicDomains = true);

  void SetSettingDescription(const char* settingName, const char* description);

  static Json::Value SerializeAsJSON(vtkSMProxy* proxy, vtkSMPropertyIterator* iter = nullptr);

  static bool DeserializeFromJSON(vtkSMProxy* proxy, const Json::Value& value);

  static double GetUserPriority();

  static double GetApplicationPriority();

protected:
  vtkSMSettings();
  ~vtkSMSettings() override;

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

  class vtkSMSettingsInternal;
  vtkSMSettingsInternal* Internal;
};

#endif