vtkSMCoreUtilities.h

Go to the documentation of this file.

/*=========================================================================

  Program:   ParaView
  Module:    vtkSMCoreUtilities.h

  Copyright (c) Kitware, Inc.
  All rights reserved.
  See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkSMCoreUtilities_h
#define vtkSMCoreUtilities_h

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

#include <string>

class vtkSMProxy;

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::string SanitizeName(const char*);


  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);

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

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

#endif