From 53b3e1855a6681f260dd70973f52af7a221b2313 Mon Sep 17 00:00:00 2001 From: Michael Wetter Date: Thu, 23 Sep 2021 12:12:00 -0700 Subject: [PATCH] Added removal of text --- .../source/sequenceDocumentation.rst | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/specification/source/sequenceDocumentation.rst b/specification/source/sequenceDocumentation.rst index 8353a813..646dad9a 100644 --- a/specification/source/sequenceDocumentation.rst +++ b/specification/source/sequenceDocumentation.rst @@ -84,7 +84,7 @@ Microsoft Word document using the following procedure. As an example, consider the following snippet of a composite control block. -.. code-block:: modelica +.. code-block:: HigMassSupplyTemperature_TRoom con(TSubSet_max=303.15, final TSubSet_min=293.15); @@ -98,6 +98,12 @@ As an example, consider the following snippet of a composite control block. final unit="K", displayUnit="degC") = 293.15 "Minimum heating supply water temperature"; + parameter Controls.OBC.CDL.Types.SimpleController + controllerType = Buildings.Controls.OBC.CDL.Types.SimpleController.P + "Type of controller" annotation (Dialog(group="Control gains")); + + ... [omitted] + annotation( Documentation( info=" @@ -108,7 +114,7 @@ As an example, consider the following snippet of a composite control block. The controller tracks the room temperature set point TRooSet by adjusting the supply water temperature set point TSupSet linearly between TSupSetMin and TSupSetMax - ... + PI-controller likely saturate due to the slow system response.

" @@ -134,11 +140,13 @@ As an example, consider the following snippet of a composite control block. src="modelica://Buildings/Resources/Images/Controls/OBC/RadiantSystems/Heating/HighMassSupplyTemperature_TRoom.png"/>

+ <-- cdl(visible=(not (controllerType is final))) or controllerType <> CDL.Types.SimpleController.P --> Note: For systems with high thermal mass, this controller should be left configured as a P-controller, which is the default setting. PI-controller likely saturate due to the slow system response.

+ <-- end cdl --> " ) ) @@ -152,9 +160,16 @@ For this control block, ``modelica-json`` will produce content for the Word desc ``TSupSetMin`` (:math:`=20^\circ`) and ``TSupSetMax`` (:math:`=30^\circ` adjustable) based on the output signal of the proportional controller..." +Note that ``modelica-json`` removes the notice at the end of the sequence description +if the ``controllerType`` is +declared as ``final`` (because then, no other choice can be made). +Through this mechanism, sections and images can be removed or enabled in the generated +sequence description. + To use IP units, ``modelica-json`` will have a configuration that specifies what units should be used. The documentation will also include the figure as declared in the CDL specification. + The Control Sequence Selection and Configuration tool could make the section ``annotation(__CDL(Documentation(info=STRING)))`` editable, thereby allowing users to customize the description of the sequence and add any other desired documentation. \ No newline at end of file