MathSolverController.h

// Copyright @ MyScript. All rights reserved.
 
#pragma once
 
#include <iink/MimeType.h>
#include <iink/graphics/PointD.h>
#include <iink/String.h>
 
#include <memory>
#include <vector>
 
namespace myscript {
namespace iink {
 
class MathExternalExpression;
class ParameterSet;
 
enum class MathDiagnostic
{
  ALLOWED                           = 0,  
  ALLOWED_BUT_PREVIOUSLY_DISCARDED  = 1,  
  UNSUPPORTED                       = 2,  
  NON_EVALUABLE                     = 3,  
  INCOMPLETE_EXPRESSION             = 4,  
  NO_VARIABLE                       = 5,  
  TOO_MANY_VARIABLES                = 6,  
  NOT_APPLICABLE                    = 7,  
  DIVISION_BY_ZERO                  = 8,  
  NUMBER_OVERFLOW                   = 9,  
  NUMBER_UNDERFLOW                  = 10, 
  INVALID_OPERATION                 = 11  
};
 
enum class MathVariableSourceType
{
  UNDEFINED   = 0, 
  API         = 1, 
  API_GLOBAL  = 2, 
  BLOCK       = 3, 
  PREDEFINED  = 4  
};
 
struct MathVariableInfo
{
  String name;                        
  MathVariableSourceType sourceType;  
  String sourceId;                    
  int occurrenceCount;                
};
 
struct MathVariableDefinition
{
  String name;  
  double value; 
  bool valid() const noexcept { return !name.isEmpty(); }
};
 
struct MathVariableDefinitionInfo
{
  double value;                       
  MathVariableSourceType sourceType;  
  String blockId;                     
};
 
struct MathVariableDefinitions
{
  String name;                                          
  std::vector<MathVariableDefinitionInfo> definitions;  
};
 
struct MathEvaluationVariables
{
  String inputName;  
  String outputName; 
};
 
class MathSolverController
{
public:
 
  virtual ~MathSolverController() = default;
 
  virtual std::vector<String> getAvailableActions(const String& blockId, std::shared_ptr<ParameterSet> overrideConfiguration = nullptr) = 0;
 
  virtual String getActionOutput(const String& blockId, const String& action, MimeType mimeType, std::shared_ptr<ParameterSet> overrideConfiguration = nullptr) = 0;
 
  virtual void applyAction(const String& blockId, const String& action, std::shared_ptr<ParameterSet> overrideConfiguration = nullptr) = 0;
 
  virtual MathDiagnostic getDiagnostic(const String& blockId, const String& task, std::shared_ptr<ParameterSet> overrideConfiguration = nullptr) = 0;
 
  virtual std::vector<MathEvaluationVariables> getEvaluables(const String& blockId) = 0;
 
  virtual std::vector<std::vector<graphics::PointD>> evaluate(const String& blockId, const MathEvaluationVariables& variables,
    double from, double to, int pointCount, std::shared_ptr<ParameterSet> overrideConfiguration = nullptr) = 0;
 
  virtual MathVariableDefinition asVariableDefinition(const String& blockId) = 0;
 
  virtual std::vector<MathVariableDefinitions> getVariableDefinitions() = 0;
 
  virtual std::vector<MathVariableInfo> getVariables(const String& blockId) = 0;
 
  virtual double getVariableValue(const String& blockId, const String& name) = 0;
 
  virtual void setVariableValue(const String& blockId, const String& name, double value) = 0;
 
  virtual bool removeVariableValue(const String& blockId, const String& name) = 0;
 
  virtual std::shared_ptr<MathExternalExpression> parseExternalExpression(const String& expression, MimeType mimeType) = 0;
};
 
}
}