Changes between Version 29 and Version 30 of LanguageChanges

Timestamp:

Apr 13, 2007, 5:49:06 PM (15 years ago)

Author:

Rafael de Pelegrini Soares

Comment:

Updated LanguageChanges (changes implemented)

LanguageChanges

@@ -1 @@
-= EMSO Language Changes Suggestions =
-
-'''NOTE: The suggestions below are being implemented in the [../browser/branches/newlanguage newlanguage repository branch].'''
-
-== '''ext''' keyword for ''global'' parameters ==
-
-Currently the '''ext''' keyword is used to obtain a ''global'' parameter.
-I've observed that this keyword is not well suited for its meaning.
+= EMSO Language Changes (version 0.9.52 and above) =
+
+== '''ext''' keyword replaced by '''outer''' ==
+
+The '''ext''' keyword was used to obtain a ''global'' parameter, it was replaced by '''outer'''.
+I've observed that this keyword was not well suited for its meaning.
 
 The idea from http://www.modelica.org is to have '''outer''' parameters, which means a parameter from one of the ''parents''.
@@ -50 +48 @@
 Then we can have parameters which are ''global'' inside of a given ''context''.
 If there is no '''intermediate''' declaration of the '''outer''' parameter, then it will be matched only on the '''FlowSheet''' and will works exactly
-as it is today.
+as the '''ext''' used to.
 
 In the above example streams from '''SUB01''' '''cannot''' be connected with streams of '''SUB02'''.
@@ -58 +56 @@
  * Then you declare such a parameter as '''outer''' on the tray model
  * And declare the parameter on the distillation column (each '''outer''' tray parameter will point to the distillation column one)
- * With the current '''ext''' implementation this is also possible, but the ''source'' parameter needs to be on the FlowSheet. In this case what about if you need two distillation columns on the same FlowSheet!?
-
-||Who || Opinion || Why ||
-||Rafael || '''agreed''' || proposed the change ||
-||Paula || '''agreed''' || because this change gives more flexibility to the user ||
-||Arge || '''in doubt''' || if two streams are used in a model with different number of '''NComp''', is it possible to set '''stream1.NComp''' and '''stream2.NComp''' to different values in that model? [[Color(red, please check the new explanation - it is not possible to have streams on the same model with different number of NComp using the outer command but it is possible for different models.)]] Please, enhance the example connecting a stream from SubProcess '''SUB01''' to SubProcess '''SUB02''', in order to see the applicability.||
-
-== CalcObject's ==
+ * With the old '''ext''' implementation this is also possible, but the ''source'' parameter needs to be on the FlowSheet. In this case what about if you need two distillation columns on the same FlowSheet!?
+
+== CalcObject's are now Plugin's ==
 
 This is another example of keyword which is not directly understood by the users.
-I suggest to use just '''Plugin''' instead of '''CalcObject'''.
+Then we adopted '''Plugin''' instead of '''CalcObject'''.
 
 Usage:
@@ -82 +75 @@
 }}}
 
-Another problem with the Plugin's is that each Plugin '''call''' (e.g. '''PP.LiquidEnthalpy(T, P, z)''') generates a units of measurement warning.
-In order to solve this problem I suggest the specification of the '''Type''' attribute even for '''outer''' Plugins (as exemplified above).
-Then we can add new property set window where the user should register a DLL for each '''Type''' of Plugin.
+Another old problem with the Plugin's is that each Plugin '''call''' (e.g. '''PP.LiquidEnthalpy(T, P, z)''') generates a units of measurement warning.
+In order to solve this problem, we created '''Type''' attribute.
+This attribute can be set even for '''outer''' Plugins (as exemplified above).
+Then we a new property set window was added, using this new dialog the user can register a DLL for each '''Type''' of Plugin.
 This way the simulator can check the units of measurement and number of arguments when checking the model and not only when the simulation is run.
 Besides this, the Plugin can be changed any time using the GUI without need to change the models.
@@ -92 +86 @@
 [[Image(PluginsConfiguration.png)]]
 
-||Who || Opinion || Why ||
-||Rafael || '''agreed''' || proposed the change ||
-||Paula || '''agreed''' || because the warnings about unit checked in models cause a bad impression ||
-||Arge || '''agreed''' || the new proposition looks better ||
-
 == Model Attributes ==
 
-Currently only '''types''' have attributes, examples:
+In previous versions only '''types''' had attributes, examples:
 {{{
 #!mso
@@ -108 +97 @@
 
 In the above type declarations, '''Brief''', '''Lower''', etc are attributes.
-We are planning to add attributes also for '''Model'''s and we need to define a syntax for their declaration.
-
-=== Option 1 ===
-
-Something similar to the types declaration:
-{{{
-#!mso
-Model MyTankModel (Icon="Tank", IconSize="normal", Brief="Model for a special kind of tank",
-    Info="The model documentation. This should be more detailed than Brief,
-    possibly spanning in multiple lines.
-    It also should be good a have some wiki formating support in the documentation.
-    Then we can have the library of models documentation automatically built based on it.")
-    PARAMETERS
-    ...
-    VARIABLES
-    ...
-end
-}}}
-
-=== Option 2 ===
-
-A new section for setting the attributes:
+Now we also have attributes for '''Model'''s, they are set using a new section called '''ATTRIBUTES''':
+
 {{{
 #!mso
@@ -149 +118 @@
 }}}
 
-=== Option 3 ===
-
-Leave the attributes handling to the graphical interface (as gPROMS does), then:
- * Models remain as they are today
- * The user edits graphically:
-   * which models appear on the '''pallet'''
-   * the documentation of the model (probably with a graphical editor with support for '''bold''', ''italics'', lists, etc
-   * which variables should appear on results
-   * which variables can be specified or not (this can be even refined supporting ''specification sets'')
-   * which is the icon for the model
-   * the relative position where the ports are shown
-
-All the information configured graphically by the user can be stored in a XML file on the same folder of the models.
-
-||Who || Opinion || Why ||
-||Rafael || '''option 3''' || With option 3 we have a clear distinction between the graphical interface and the models ||
-||Paula ||'''option 2''' || Because the graphical interface is so far from a usable version and with option 2 a parser can be made to automaticaly generate the documentation in pdf, wiki and to the graphical interface ||
-||Arge ||'''option 2''' || In agreement with Paula's comment about parsers and also because the graphical interface can overwrite those attributes and store them in a XML file of the flowsheet without changing the library models ||
-
 == Switcher for equations ==
 
-Currently, continuous-discrete modeling is supported in EMSO using the '''if''' statement.
-But some more complex situations cannot be modeled with '''if'''.
+In previous versions, continuous-discrete modeling is supported in EMSO only using the '''if''' statement.
+But some more complex situations cannot be modeled with just a '''if'''.
 
 For example, a safety valve which opens if the pressure is higher than 2 atm but closes only when the pressure is lower than the outside pressure.
-This situation cannot be modeled by a simply '''if'''. For this case, a State Transition Network (STN) is needed.
-
-For this case the '''Switcher''' is proposed, usage:
+This situation cannot be modeled by a trivial '''if'''. For this case, a State Transition Network (STN) is needed.
+
+For this case the '''Switcher''' parameter type was added, usage:
 {{{
 #!mso
@@ -196 +146 @@
 }}}
 
-In the piece of code above there are the following news:
+In the piece of code above, there are the following news:
  * A new basic type called '''Switcher'''
  * The '''Switcher''' type has an extra attribute called '''Valid''' which are the valid values for the switcher
@@ -202 +152 @@
  * There is a '''when''' ... '''switchto''' command which can be used inside a '''case''' of a '''switch'''. NOTE: the '''when''' command is optional, however if this command is missing then the '''case''' is a '''black hole''': there is no way to get out! :)
 
-||Who || Opinion || Why ||
-||Rafael || '''agreed''' || proposed the change ||
-||Paula || '''agreed''' || this change is very usefull to overcome the limitations in '''if''' structure ||
-||Arge || '''agreed''' || very important resource ||
-
 == Units Of Measurement (UOM) ==
 
-Currently EMSO support Units Of Measurement (UOM) for variables, parameters, equations, etc.
+In previous versions of EMSO, there was Units Of Measurement (UOM) support for variables, parameters, equations, etc.
 The problem is that the units of measurement are declared exactly as string text (with double quotes, eg "kg/h")
 
-I think it should be a good idea to directly distinguish texts from UOM in some way:
- * We could use the simple quote for UOM, eg. 'kg/h'
- * We could use the '''{''', eg. {kg/h}
-
-||Who || Opinion || Why ||
-||Rafael || '''in doubt''' || I still don't know which is the better way to distinguish a Text from a UOM ||
-||Arge || '''agreed''' || Single quote seems to be the better solution, and it helps to distinguish an equation name from an UOM at the beginnig of an expression ||
-||Paula || '''agreed''' || I prefer single quote ||
+In recent versions we decided to distinguish texts from UOM using a different notation:
+ * Units of measurement are declared with single quote, eg. 'kg/h'
+ * Text elements are declared with double quote, eg. "This is a Text"
 
 == Another UOM problems ==
 
-Currently EMSO support Units Of Measurement (UOM) for variables, parameters, equations, etc.
-But there is a potential problem when deriving types with a UOM:
+In previous versions of EMSO, there was Units Of Measurement (UOM) support for variables, parameters, equations, etc.
+But there was a potential problem when deriving types with a UOM:
 
 {{{
@@ -239 +179 @@
  - What about the limits if the UOM changed?
 
-In order to fix this kind of problem the following changes are proposed:
- - add a '''final''' modifier for the attributes, preventing it to be changed
- - add another attribute called '''DisplayUnit''', which should be compatible with '''Unit''' (the GUI will report all results converted to this UOM)
- - the limits are considered to be in respect to the '''Unit''' and not '''DisplayUnit'''
- - declare all UOM in '''types.mso''' as '''final'''
-
-Sample code with the propositions included:
+In order to fix this kind of problem the following changes were implemented:
+ - added a '''final''' modifier for the attributes, preventing it to be changed when deriving from it
+ - added another attribute called '''DisplayUnit''', which should be compatible with '''Unit''' (the GUI will report all results converted to the '''DisplayUnit''')
+ - now the limits are considered to be in respect to the '''Unit''' and not '''DisplayUnit'''
+ - now all UOM declared in '''types.mso''' has the '''final''' attribute set
+
+Sample code showing the news for UOM:
 {{{
 #!mso
@@ -264 +204 @@
 }}}
 
-
-||Who || Opinion || Why ||
-||Rafael || '''agreed''' || Proposed the change ||
+= Not Yet Implemented Suggestions =
 
 == OPTIONS section ==