src/Expr/Expr_SystemRelation.cdl

   1 -- File:        SystemRelation.cdl
   2 -- Created:     Mon Jan 14 09:50:50 1991
   3 -- Author:      Arnaud BOUZY
   4 --              <adn@topsn3>
   5 ---Copyright:    Matra Datavision 1991
   6
   7 class SystemRelation from Expr
   8
   9 inherits GeneralRelation from Expr
  10
  11 uses SequenceOfGeneralRelation from Expr,
  12     GeneralExpression from Expr,
  13     NamedUnknown from Expr,
  14     AsciiString from TCollection
  15
  16 raises OutOfRange,NoSuchObject,DimensionMismatch,NumericError
  17
  18 is
  19
  20     Create(relation : GeneralRelation)
  21     ---Purpose: Creates a system with one relation
  22     ---Level : Advanced
  23     returns mutable SystemRelation;
  24
  25     Add(me : mutable; relation : GeneralRelation)
  26     ---Purpose: Appends <relation> in the list of components of <me>.
  27     ---Level : Advanced
  28     is static;
  29
  30     Remove(me : mutable; relation : GeneralRelation)
  31     ---Level : Internal
  32     raises NoSuchObject,DimensionMismatch
  33     is static;
  34
  35     IsLinear(me)
  36     ---Purpose: Tests if <me> is linear between its NamedUnknowns.
  37     returns Boolean
  38     is static;
  39
  40     NbOfSubRelations(me)
  41     ---Purpose: Returns the number of relations contained in <me>.
  42     returns Integer
  43     is static;
  44
  45     NbOfSingleRelations(me)
  46     ---Purpose: Returns the number of SingleRelations contained in
  47     --          <me>.
  48     returns Integer
  49     is static;
  50
  51     SubRelation(me; index : Integer)
  52     ---Purpose: Returns the relation denoted by <index> in <me>.
  53     --          An exception is raised if <index> is out of range.
  54     returns any GeneralRelation
  55     raises OutOfRange
  56     is static;
  57
  58     IsSatisfied(me)
  59     returns Boolean;
  60
  61     Simplified(me)
  62     ---Purpose: Returns a GeneralRelation after replacement of
  63     --          NamedUnknowns by an associated expression, and after
  64     --          values computation.
  65     returns mutable GeneralRelation
  66     raises NumericError;
  67
  68     Simplify(me : mutable)
  69     ---Purpose: Replaces NamedUnknowns by associated expressions,
  70     --          and computes values in <me>.
  71     raises NumericError;
  72
  73     Copy(me)
  74     ---Purpose: Returns a copy of <me> having the same unknowns and functions.
  75     returns mutable like me;
  76
  77     Contains(me; exp : GeneralExpression)
  78     ---Purpose: Tests if <me> contains <exp>.
  79     returns Boolean;
  80
  81     Replace(me : mutable ; var : NamedUnknown ; with : GeneralExpression);
  82     ---Purpose: Replaces all occurences of <var> with <with> in <me>.
  83
  84     String(me)
  85     ---Purpose: returns a string representing <me> in a readable way.
  86     returns AsciiString;
  87
  88 fields
  89
  90     myRelations : SequenceOfGeneralRelation;
  91
  92
  93 end SystemRelation;