Rename Modelica.Icons.{RotationalSensor, TranslationalSensor}

[beutlich]

Closes #340.

[christiankral]

When I checkout the branch abeutlich:rename-icons I cannot find the the guidelines of sensor design added in f0a841a and b8dfa02. These guidelines contain a modelica:// link to the round and rectangular sensor icon, so I suppose these links have to be updated as well.

[tobolar]

I stumble a bit about the naming of the icons. As I stated in #2301 (comment), I rather prefer to follow the Indexing rules decribed e.g. in https://www.asindexing.org/best-indexing-practices. Following that rules, a subheading (round, rectangular) shall be predeceased by a main heading (sensor). The suggested names follow indeed reverse order.

I know there is no such rule defined in MSL, but even in the Modelica.Icons package itself, there can be found both approaches - simply compare names of "package" icons to those of "type" icons.
So my recommendation is to use SensorRectangular instead of RectangularSensor (and similarly for RoundSensor.

As I know this could trigger a large discussion (which is fine), I only leave my concern as a comment.

[tobolar]

The element's desription (and documentation) shall be modified accordingly. Whereby the RoundSensor is "Icon representing a round measurement device", the RectangularSensor is "... a linear measurement device".

To be really honest, is is not clear at all when to use which icon for a sensor component. Neither it is described in Modelica.UsersGuide.Conventions.Icons.

A link to Modelica.UsersGuide.Conventions.Icons shall be established in the documentation of the two sensor icons as well.

[tobolar]

Does not this concern both 813 and 340 issues?

[christiankral]

Some examples: * = current implementation

Main first	Main second
SensorVoltage	VoltageSensor *
VoltageSignal	SignalVoltage *
SensorRound	RoundSensor *
DiodeIdeal	IdealDiode *
MachineInduction	InductionMachine *
ThermalPortTransformer *	TransformerThermalPort
ElectroMagneticConverterSinglePhase	SinglePhaseElectroMagneticConverter *
AdaptorAngleToTorque	AngleToTorqueAdaptor *

[christiankral]

I stumble a bit about the naming of the icons. As I stated in #2301 (comment), I rather prefer to follow the Indexing rules decribed e.g. in https://www.asindexing.org/wp-content/uploads/2014/04/ASI-BestPracticesIndexing2015-linked-updated-copyright-v3-02-26-16.pdf. Following that rules, a subheading (round, rectangular) shall be predeceased by a main heading (sensor). The suggested names follow indeed reverse order.

Is there a membership required to access the PDF file provided by the link above? I get the following error message when trying to access the PDF file: Error 404 - Page not found!

[christiankral]

The new notation would require to rename most of the actual class names. So someone familiar with the structure of the MSL, will not recognize it any more after the re-design. So I am not convinced that this is the right way to go. However, even though I could live with most of the new names, the class name MachineInduction sounds definitely a lot too crazy to me. In case of the electric machines a hierarchical structure could solve the naming problem, somehow:

• Machines.Induction.SquirrelCage
• Machines.Induction.SlipRing
• Machines.Synchronous.PermanentMagnet
• Machines.Synchronous.ElectricalExcited
• Machines.Synchronous.ReluctanceRotor

In the very same way, for example, sources could be structured as:

• Analog.Sources.Voltage.Signal
• Analog.Sources.Voltage.Constant
• Analog.Sources.Current.Signal
• Analog.Sources.Current.Constant
  etc.

I think it were difficult to decide when a new package shall be introduced. Are two machine models enough? So the structuring would also change the existing hierarchy of the MSL a lot. To me it seems to be a an overkill, too.

[tobolar]

Is there a membership required...

No idea why the link is not working. Please find the pdf via https://www.asindexing.org/best-indexing-practices.

[tobolar]

@christiankral

In case of the electric machines a hierarchical structure could solve the naming problem,...

This would definitely be the consequence. But I agree it would require too much effort. So let us just make a notice of this.

[AHaumer]

Please stop this discussion ... I'm strictly agianst such crazy things like
Machines.Induction.SquirrelCage or Analog.Sources.Voltage.Signal

[christiankral]

@AHaumer This PR does not introduce any crazy namings. This PR sticks to the existing naming conventions. So you can just go ahead regularly review this PR.