Case.h

Go to the documentation of this file.

 
/*====================================================================================================================*/
/*==  Guards, Includes  ==============================================================================================*/
/*====================================================================================================================*/
 
// INCLUDE GUARDS
//
#ifndef LIBPF_USER_CASE_H
#define LIBPF_USER_CASE_H
 
/* SYSTEM INCLUDES */
//
#include <string>                       // for string
 
/* PROJECT INCLUDES */
//
 
/* LOCAL INCLUDES */
//
#include <libpf/user/Handle.h>
#include <libpf/core/SensitivityResult.h>
 
/* FORWARD REFERENCES */
//
class SensitivityInput;
class HomotopyInput;
 
namespace Libpf {
namespace User {
 
/*====================================================================================================================*/
/*==  class CallBack declaration =====================================================================================*/
/*====================================================================================================================*/
 
class CallBack {
protected:
  std::string message_;
public:
  CallBack(std::string message);
  virtual ~CallBack();
  virtual void run(const std::string &data);
}; // class CallBack
 
/*====================================================================================================================*/
/*==  class Case declaration =========================================================================================*/
/*====================================================================================================================*/
 
class Case {
private:
  void *pimpl_;
  Case(const Case&);   // disable default copy contructor
  Case& operator=(const Case&); // disable default assignment operator
public:
  enum ErrorCode { ERROR_OK = 0, 
    ERROR_INVALID = -81,         
    ERROR_COMMUNICATION = -82,   
    ERROR_ARGUMENT = -83,        
    ERROR_SERVER = -84           
  }; // enum ErrorCode
  
  Case(const Handle &handle);
  ~Case(void);
 
  int setTag(const char *tag);
  int setDescription(const char *desc);
  int abort(void);
  
  int calculate(void);
  int calculateSync(void);
  int check(void);
  int sensitivity(const SensitivityInput &sensitivityInput);
  int sensitivity(const std::string &jsonSensitivityInput);
  SensitivityResult sensitivitySync(const SensitivityInput &sensitivityInput, int &error);
  std::string sensitivitySync(const std::string &jsonSensitivityInput, int &error);
 
  int homotopy(const HomotopyInput &homotopyInput);
  int homotopy(const std::string &jsonHomotopyInput);
  int homotopySync(const HomotopyInput &homotopyInput);
  int homotopySync(const std::string &jsonHomotopyInput);
  
  double get(const std::string &path, int &error);
  double get(const std::string &path, const std::string &unit, int &error);
  int getInteger(const std::string &path, int &error);
  std::string getString(const std::string &path, int &error);
  
  void setCalculateRunningCallBack(CallBack *callBack);
  void setCalculateFinishCallBack(CallBack *callBack);
  void setIntermediateSensitivityResultsCallBack(CallBack *callBack);
  void setSensitivityFinishCallBack(CallBack *callBack);
  void setHomotopyRunningCallBack(CallBack *callBack);
  void setHomotopyFinishCallBack(CallBack *callBack);
  
  int exportDataBase(const std::string &sqliteFileName) const;
  int exportTxt(const std::string &txtFileName) const;
  int exportJson(const std::string &jsonFileName) const;
  int exportOds(const std::string &xmlFileName) const;
 
  int set(const HomotopyInput &homotopyInput);
  int set(const std::string &jsonHomotopyInput);  
 
  std::vector<std::string> exportSvgs(const std::string &dir, bool tiny, int &error);
 
  int exportXml(const std::string &dir);
 
  int setTest(void);
 
  int setCheck(void);
 
/*
  void exportAllXml();
*/
  bool isValid(void) const;
  
  static std::string errorMessage(int error);
 
#ifndef SWIG
  void *model(void);
#endif
}; // class Case
 
} // namespace User
} // namespace Libpf 
 
#endif // LIBPF_USER_CASE_H