modelica / ModelicaStandardLibrary

Free (standard conforming) library to model mechanical (1D/3D), electrical (analog, digital, machines), magnetic, thermal, fluid, control systems and hierarchical state machines. Also numerical functions and functions for strings, files and streams are included.
https://doc.modelica.org
BSD 3-Clause "New" or "Revised" License
459 stars 166 forks source link

Discrepances in position, size and color of connectors' names #2481

Open tobolar opened 6 years ago

tobolar commented 6 years ago

Connectors within the MSL differ in the position, size and color of their name primitive. In the figure attached, there are shown some of the connectors from different domains.

There should be defined a convention on how to handle the connectors' names, similar to Modelica.UsersGuide.Conventions.Icons. See also discussion on descriptive text in #2471.

connectorsnames

christiankral commented 6 years ago

I would also prefer to have a consistent way of defining a positive and negative (or what ever their name is) connector by extending from a base connector definitions. This is, however, handled differently in different packages. The base class shall not have an icon. Icons shall be added by the positive and negative connector definitions.

Example 1: Modelica.Mechanics.Rotational.Interfaces

connector Flange_a "One-dimensional rotational flange of a shaft (filled circle icon)"
  SI.Angle phi "Absolute rotation angle of flange";
  flow SI.Torque tau "Cut torque in the flange";
end Flange_a;

Example 2: Modelica.Electrical.MultiPhase.Interfaces:

connector Plug "Plug with m pins for an electric component"
  parameter Integer m(final min=1) = 3 "Number of phases";
  Modelica.Electrical.Analog.Interfaces.Pin pin[m];
end Plug;
connector PositivePlug "Positive plug with m pins"
  extends Plug;
end PositivePlug;