CCGS.idl

Go to the documentation of this file.

#include "CellML_APISPEC.idl"
#include "MathML_content_APISPEC.idl"
#include "MaLaES.idl"

module cellml_services
{
  interface CustomGenerator;

  enum VariableEvaluationType
  {
    VARIABLE_OF_INTEGRATION,
    
    CONSTANT,
    
    STATE_VARIABLE,
    
    ALGEBRAIC,
    
    FLOATING,
    
    LOCALLY_BOUND,
    
    PSEUDOSTATE_VARIABLE
  };

  enum ModelConstraintLevel
  {
    UNDERCONSTRAINED,
    
    UNSUITABLY_CONSTRAINED,
    
    OVERCONSTRAINED,
    
    CORRECTLY_CONSTRAINED
  };

  interface ComputationTarget
    : XPCOM::IObject
  {
    readonly attribute cellml_api::CellMLVariable variable;
    
    readonly attribute unsigned long degree;
    
    readonly attribute VariableEvaluationType type;
    
    readonly attribute wstring name;
    
    readonly attribute unsigned long assignedIndex;
  };
#pragma terminal-interface
  
  interface ComputationTargetIterator
    : XPCOM::IObject
  {
    ComputationTarget nextComputationTarget();
  };
#pragma terminal-interface
  
  interface CodeInformation
    : XPCOM::IObject
  {
    readonly attribute wstring errorMessage;
    
    readonly attribute ModelConstraintLevel constraintLevel;
    
    readonly attribute unsigned long algebraicIndexCount;
    
    readonly attribute unsigned long rateIndexCount;
    
    readonly attribute unsigned long constantIndexCount;
    
    readonly attribute wstring initConstsString;

    readonly attribute wstring ratesString;

    readonly attribute wstring variablesString;

    readonly attribute wstring functionsString;

    ComputationTargetIterator iterateTargets();

    readonly attribute mathml_dom::MathMLNodeList flaggedEquations;

    readonly attribute ComputationTarget missingInitial;
  };
#pragma cross-module-argument

  interface CodeGenerator
    : XPCOM::IObject
  {
    attribute wstring constantPattern;

    attribute wstring stateVariableNamePattern;

    attribute wstring algebraicVariableNamePattern;

    attribute wstring rateNamePattern;

    attribute wstring voiPattern;
    
   attribute wstring sampleDensityFunctionPattern;

   attribute wstring sampleRealisationsPattern;

   attribute wstring boundVariableName;

    attribute unsigned long arrayOffset;
    
    attribute wstring assignPattern;
    
    attribute wstring solvePattern;
    
    attribute wstring solveNLSystemPattern;

    attribute wstring temporaryVariablePattern;

    attribute wstring declareTemporaryPattern;

    attribute wstring conditionalAssignmentPattern;

    attribute cellml_services::MaLaESTransform transform;

    attribute cellml_services::CeVAS useCeVAS;

    attribute cellml_services::CUSES useCUSES;

    attribute cellml_services::AnnotationSet useAnnoSet;
    
    CodeInformation generateCode(in cellml_api::Model sourceModel);
    
    CustomGenerator createCustomGenerator(in cellml_api::Model sourceModel);
    
    attribute boolean allowPassthrough;
  };
#pragma cross-module-argument

  interface CustomCodeInformation
    : XPCOM::IObject
  {
    readonly attribute ModelConstraintLevel constraintLevel;
    
    readonly attribute unsigned long indexCount;
    
    ComputationTargetIterator iterateTargets();

    readonly attribute wstring generatedCode;

    readonly attribute wstring functionsString;
};

interface CustomGenerator
  : XPCOM::IObject
{
  ComputationTargetIterator iterateTargets();
  
  void requestComputation(in ComputationTarget wanted) raises(cellml_api::CellMLException);

  void markAsKnown(in ComputationTarget known);

  void markAsUnwanted(in ComputationTarget unwanted);

  CustomCodeInformation generateCode();
};

 interface IDACodeInformation
   : CodeInformation
 {
   readonly attribute wstring essentialVariablesString;

   readonly attribute wstring stateInformationString;

   readonly attribute unsigned long conditionVariableCount;

   readonly attribute wstring rootInformationString;
 };
#pragma terminal-interface
#pragma cross-module-argument

 interface IDACodeGenerator
   : CodeGenerator
 {
   IDACodeInformation generateIDACode(in cellml_api::Model sourceModel);

   attribute wstring residualPattern;

   attribute wstring constrainedRateStateInfoPattern;

   attribute wstring unconstrainedRateStateInfoPattern;

   attribute wstring infDelayedRatePattern;

   attribute wstring infDelayedStatePattern;

   attribute boolean trackPiecewiseConditions;

   attribute wstring conditionVariablePattern;
 };
#pragma terminal-interface
#pragma cross-module-argument

 interface CodeGeneratorBootstrap
   : XPCOM::IObject
 {
   CodeGenerator createCodeGenerator();
   IDACodeGenerator createIDACodeGenerator();
 };
#pragma terminal-interface
#pragma cross-module-argument

};