CIS.idl

Go to the documentation of this file.

#include "xpcom.idl"
#include "CCGS.idl"

module cellml_services
{
  typedef sequence<double> DoubleSeq;

  enum ODEIntegrationStepType
  {
    RUNGE_KUTTA_2_3,
    RUNGE_KUTTA_4,
    RUNGE_KUTTA_FEHLBERG_4_5,
    RUNGE_KUTTA_CASH_KARP_4_5,
    RUNGE_KUTTA_PRINCE_DORMAND_8_9,
    RUNGE_KUTTA_IMPLICIT_2,
    RUNGE_KUTTA_IMPLICIT_2_SOLVE,
    RUNGE_KUTTA_IMPLICIT_4,
    BULIRSCH_STOER_IMPLICIT_BD,
    GEAR_1,
    GEAR_2,
    ADAMS_MOULTON_1_12,
    BDF_IMPLICIT_1_5_SOLVE
  };

  interface IntegrationProgressObserver
    : XPCOM::IObject
  {
    void computedConstants(in DoubleSeq values);

    void results(in DoubleSeq state);

    void done();

    void failed(in string errorMessage);
  };
#pragma terminal-interface
#pragma user-callback

  interface CellMLIntegrationRun
    : XPCOM::IObject
  {
    void setStepSizeControl(in double epsAbs, in double epsRel,
                            in double scalVar, in double scalRate,
                            in double maxStep);

     void setTabulationStepControl(in double tabulationStepSize, in boolean strictTabulation);

    void setResultRange(in double startBvar, in double stopBvar,
                        in double maxPointDensity);

    void setProgressObserver(in IntegrationProgressObserver ipo);

    void setOverride(
                     in cellml_services::VariableEvaluationType type,
                     in unsigned long variableIndex,
                     in double newValue
                    ) raises(cellml_api::CellMLException);

    void start();

    void stop();

    void pause();

    void resume();
  };

  interface ODESolverRun
    : CellMLIntegrationRun
  {
    attribute ODEIntegrationStepType stepType;
  };
#pragma terminal-interface

  interface DAESolverRun
    : CellMLIntegrationRun
  {
  };
#pragma terminal-interface

  interface CellMLCompiledModel
    : XPCOM::IObject
  {
    readonly attribute cellml_api::Model model;

    readonly attribute cellml_services::CodeInformation codeInformation;
  };

  interface ODESolverCompiledModel
    : CellMLCompiledModel
  {
  };
#pragma terminal-interface

  interface DAESolverCompiledModel
    : CellMLCompiledModel
  {
  };
#pragma terminal-interface

  interface CellMLIntegrationService
    : XPCOM::IObject
  {
    ODESolverCompiledModel compileModelODE(in cellml_api::Model aModel)
      raises(cellml_api::CellMLException);

    ODESolverCompiledModel compileDebugModelODE(in cellml_api::Model aModel)
      raises(cellml_api::CellMLException);

    DAESolverCompiledModel compileModelDAE(in cellml_api::Model aModel)
      raises(cellml_api::CellMLException);

    DAESolverCompiledModel compileDebugModelDAE(in cellml_api::Model aModel)
      raises(cellml_api::CellMLException);

    ODESolverRun createODEIntegrationRun(in ODESolverCompiledModel aModel);

    DAESolverRun createDAEIntegrationRun(in DAESolverCompiledModel aModel);

    readonly attribute wstring lastError;
  };
#pragma terminal-interface
};