forked from UdK-VPT/BuildingSystems
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathConventions.mo
More file actions
30 lines (29 loc) · 2.6 KB
/
Copy pathConventions.mo
File metadata and controls
30 lines (29 loc) · 2.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
within BuildingSystems.UsersGuide;
class Conventions "Conventions"
extends Modelica.Icons.Information;
annotation (Documentation(info="<html>
<p>This library follows the conventions of the <a href=\"modelica://Modelica.UsersGuide.Conventions\">Modelica Standard Library</a>, which are as follows: </p>
<p>Note, in the html documentation of any Modelica library, the headings "h1, h2, h3" should not be used, because they are utilized from the automatically generated documentation/headings. Additional headings in the html documentation should start with "h4". </p>
<p>In the Modelica package the following conventions are used: </p>
<ol>
<li><b>Class and instance names</b> are written in upper and lower case letters, e.g., "PipeStraight". An underscore is only used at the end of a name to characterize a lower or upper index, e.g., "port_1".<br/> </li>
<li><b>Class names</b> start always with an upper case letter.<br/> </li>
<li><b>Instance names</b>, i.e., names of component instances and of variables (with the exception of constants), start usually with a lower case letter with only a few exceptions if this is common sense (such as "T" for a temperature variable).<br/> </li>
<li><b>Constant names</b>, i.e., names of variables declared with the "constant" prefix, follow the usual naming conventions (= upper and lower case letters) and start usually with an upper case letter, e.g. UniformGravity, SteadyState.<br/> </li>
<li>The <b>instance name</b> of a component is always displayed in its icon (= text string "%name") in <b>blue color</b>. A connector class has the instance name definition in the diagram layer and not in the icon layer. <b>Parameter</b> values, e.g., resistance, mass, gear ratio, are displayed in the icon in <b>black color</b> in a smaller font size as the instance name. <br/> </li>
<li>A main package has usually the following subpackages: </li>
<li><ul>
<li><b>UsersGuide</b> containing an overall description of the library and how to use it. </li>
<li><b>Examples</b> containing models demonstrating the usage of the library. </li>
<li><b>Interfaces</b> containing connectors and partial models. </li>
<li><b>Types</b> containing type, enumeration and choice definitions. </li>
</ul></li>
</ol>
<p>The <code>BuildingSystems</code> library uses the following conventions in addition to the ones of the Modelica Standard Library: </p>
<ol>
<li>a </li>
<li>b </li>
<li>b </li>
</ol>
</html>"));
end Conventions;