CUSES.idl

Go to the documentation of this file.

#include "CellML_APISPEC.idl"

module cellml_services
{
  interface BaseUnit
    : XPCOM::IObject
  {
    readonly attribute wstring name;
  };

  interface UserBaseUnit
    : BaseUnit
  {
    readonly attribute cellml_api::Units cellmlUnits;
  };

  interface BaseUnitInstance
    : XPCOM::IObject
  {
    readonly attribute BaseUnit unit;

    readonly attribute double prefix;

    readonly attribute double offset;

    readonly attribute double exponent;
  };

  interface CanonicalUnitRepresentation
    : XPCOM::IObject
  {
    readonly attribute unsigned long length;

    BaseUnitInstance fetchBaseUnit(in unsigned long index)
      raises(cellml_api::CellMLException);

    boolean compatibleWith(in CanonicalUnitRepresentation aCompareWith);

    double convertUnits(in CanonicalUnitRepresentation aConvertTo,
                        out double offset);

    double siConversion(out double offset);

    void addBaseUnit(in BaseUnitInstance baseUnit);

    CanonicalUnitRepresentation mergeWith(in double thisExponent,
                                          in CanonicalUnitRepresentation other,
                                          in double otherExponent)
      raises(cellml_api::CellMLException);
  };

  interface CUSES
    : XPCOM::IObject
  {
    readonly attribute wstring modelError;

    CanonicalUnitRepresentation getUnitsByName(in cellml_api::CellMLElement aContext,
                                               in wstring aName);

    CanonicalUnitRepresentation createEmptyUnits();
  };

  interface CUSESBootstrap
    : XPCOM::IObject
  {
    CUSES createCUSESForModel(in cellml_api::Model aModel, in boolean aStrict);
  };
};