vtkSMCoreUtilities.h

Go to the documentation of this file.

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

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

#include <optional> // for std::optional
#include <string>   // for std::string
#include <vector>   // for std::vector

class vtkSMProxy;
class vtkSMStringVectorProperty;

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

  static const char* GetFileNameProperty(vtkSMProxy*);

  static std::vector<std::string> GetFileNameProperties(vtkSMProxy* proxy);

  static std::string SanitizeName(const char*);
  static std::string SanitizeName(const std::string& name)
  {
    return vtkSMCoreUtilities::SanitizeName(name.c_str());
  }


  static bool AdjustRangeForLog(double range[2]);
  static bool AdjustRangeForLog(double& rmin, double& rmax)
  {
    double range[2] = { rmin, rmax };
    bool retVal = vtkSMCoreUtilities::AdjustRangeForLog(range);
    rmin = range[0];
    rmax = range[1];
    return retVal;
  }


  static bool AdjustRange(double range[2]);
  static bool AdjustRange(double& rmin, double& rmax)
  {
    double range[2] = { rmin, rmax };
    bool retVal = vtkSMCoreUtilities::AdjustRange(range);
    rmin = range[0];
    rmax = range[1];
    return retVal;
  }


  static bool AlmostEqual(const double range[2], int ulpsDiff);
  static bool AlmostEqual(double rmin, double rmax, int ulpsDiff)
  {
    double range[2] = { rmin, rmax };
    return vtkSMCoreUtilities::AlmostEqual(range, ulpsDiff);
  }


  static const char* GetInputPropertyName(vtkSMProxy* proxy, int port = 0);

  static const char* GetStringForCellType(int cellType);


  static void ReplaceReaderFileName(
    vtkSMProxy* proxy, const std::vector<std::string>& files, const char* propName)
  {
    vtkSMCoreUtilities::ReplaceReaderFileName(proxy, files, propName, false);
  }
  static void ReplaceReaderFileName(vtkSMProxy* proxy, const std::vector<std::string>& files,
    const char* propName, bool userModifiedName);

  static std::string FindLargestPrefix(const std::vector<std::string>& files);

  static std::optional<std::string> RecoverRegistrationName(vtkSMProxy* proxy);


  static std::string GetFileNameFromFileNameList(const std::vector<std::string>& fileNames);
  static std::string GetFileNameFromFileNameList(vtkSMStringVectorProperty* stringVectorProperty);

protected:
  vtkSMCoreUtilities();
  ~vtkSMCoreUtilities() override;

private:
  vtkSMCoreUtilities(const vtkSMCoreUtilities&) = delete;
  void operator=(const vtkSMCoreUtilities&) = delete;
};

#endif