CellML_Context.idl

Go to the documentation of this file.

#include "CellML_APISPEC.idl"

module cellml_context
{
  interface CellMLModule : XPCOM::IObject
  {
    enum ModuleTypes
    {
      TOOL,
      SERVICE
    };

    readonly attribute ModuleTypes moduleType;

    readonly attribute wstring moduleName;

    readonly attribute wstring moduleDescription;

    readonly attribute wstring moduleVersion;

    readonly attribute wstring moduleIconURL;

    void unload();
  };
#pragma cross-module-inheritance

  interface CellMLModuleIterator : XPCOM::IObject
  {
    CellMLModule nextModule();
  };
#pragma terminal-interface

  interface ModelNode;

  interface ModelNodeIterator : XPCOM::IObject
  {
    ModelNode nextModelNode();
  };
#pragma terminal-interface

  interface CellMLModuleMonitor : XPCOM::IObject
  {
    void moduleRegistered(in CellMLModule mod);

    void moduleDeregistered(in CellMLModule mod);
  };
#pragma terminal-interface
#pragma user-callback

  interface CellMLModuleManager : XPCOM::IObject
  {
    void registerModule(in CellMLModule mod);

    void deregisterModule(in CellMLModule mod);

    CellMLModule findModuleByName(in wstring moduleName,
                                  in wstring moduleVersion)
      raises(cellml_api::CellMLException);

    void requestModuleByName(in wstring moduleName, in wstring moduleVersion)
      raises(cellml_api::CellMLException);

    void addMonitor(in CellMLModuleMonitor moduleMonitor);

    void removeMonitor(in CellMLModuleMonitor moduleMonitor);

    CellMLModuleIterator iterateModules();
  };
#pragma terminal-interface

  interface CellMLTypeAnnotationManager : XPCOM::IObject
  {
    void setUserData(in wstring type, in wstring key, in XPCOM::IObject data);

    XPCOM::IObject getUserData(in wstring type, in wstring key)
      raises(cellml_api::CellMLException);
  };
#pragma terminal-interface

  interface ModelList;
  interface ModelNode;

  interface ModelNodeMonitor : XPCOM::IObject
  {
    void modelRenamed(in ModelNode renamedNode,
                      in wstring newName);

    void modelReplaced(in ModelNode changedNode,
                       in cellml_api::Model newModel);

    void changesFlushed(in ModelNode changedNode);

    void ownerChanged(in ModelNode changedNode, in XPCOM::IObject newOwner);

    void modelFrozenStateChanged(in ModelNode changedNode,
                                 in boolean newState);
  };
#pragma terminal-interface

  interface ModelListMonitor : XPCOM::IObject
  {
    void modelAdded(in ModelNode newNode, in short depth);

    void modelRemoved(in ModelNode oldNode, in short depth);
  };
#pragma terminal-interface
#pragma user-callback

  interface ModelNode : XPCOM::IObject
  {
    attribute wstring name;

    ModelNode getLatestDerivative();

    ModelNode getWritable();

    attribute boolean isFrozen;

    readonly attribute unsigned long modificationTimestamp;

    void stampModifiedNow();

    attribute cellml_api::Model model;

    void flushChanges();

    attribute XPCOM::IObject owner;

    readonly attribute ModelList derivedModels;

    void addModelMonitor(in ModelNodeMonitor monitor);

    void removeModelMonitor(in ModelNodeMonitor monitor);

    readonly attribute ModelList parentList;

    attribute boolean dirty;
  };
#pragma terminal-interface

  interface ModelList : XPCOM::IObject
  {
    void addModelMonitor(in ModelNodeMonitor monitor);

    void removeModelMonitor(in ModelNodeMonitor monitor);

    void addListMonitor(in ModelListMonitor monitor);

    void removeListMonitor(in ModelListMonitor monitor);

    ModelNode makeNode(in cellml_api::Model mod);

    void addModel(in ModelNode node);

    void removeModel(in ModelNode node);

    ModelNodeIterator iterateModelNodes();

    readonly attribute ModelNode parentNode;
  };
#pragma terminal-interface

  interface CellMLContext : XPCOM::IObject
  {
    readonly attribute CellMLModuleManager moduleManager;

    readonly attribute CellMLTypeAnnotationManager typeAnnotationManager;
    
    readonly attribute cellml_api::CellMLBootstrap cellmlBootstrap;

    readonly attribute ModelList loadedModels;
  };
#pragma terminal-interface
};