SysPhS-1.1: Annex A.5: Humidifier: Naming not very consistent across parts, input/output Port name, value properties, or constraint parameters

This page identifies a possible issue, inconsistency, concern, error, or bug!
One of the ways Webel IT Australia helps promote tools, technologies, and languages is by donating a lot of time identifying, tracking, and reporting potential issues, in order to help vendors and developers improve the tools and technologies. In some cases, we also offer workarounds and advice for users. All issues tracked on our public site are offered most constructively and with sincerest gratitude to the tool vendors and technology developers.
DISCLAIMER: Vendors do not officially endorse issue analysis by Webel IT Australia.
Icon class
icon_class
far fa-sticky-note
icon_class_computed
far fa-sticky-note
Note kind
ISSUE
Policy level
SUGGESTED
Specification keywords
SysPhS-1.1
UML keywords
Port
SysMLv1.x keywords
"standard" Port
Block
block property
constraint parameter
value property
Keywords

Many might consider this not very important, but the naming throughout the SysPhS-1.1 specifications is rather inconsistent, and particularly in the (otherwise excellent) Humidifier example.

Ultimately, introducing more consistent habits - such as the Webel Best Practice items - will help inform your modelling, and also can also save you a lot of time, as well as making it easier to analyse your projects, and make nicer diagrams that communicate well.

Compare: 

mLpH2mLpS : VolumeConversion
toPercentage : PercentageConversion


vPC : VaporPressureCalculation
relHumCalc : RelativeHumidityCalculation
The port naming in the Humidifier spec example is particularly uneven. If you are attending a Webel course or following the online Webel trails please don't mimic that spec sample's naming, please use this instead:
Webel Best Practice: Webel: If you must name your Ports or Pins, name them simply 'i', 'o', or 'io' (or 'oi') to indicate direction UNLESS you have to indicate a special role like 'iRole', 'oAuxiliary'. DO NOT use Port or Pin names like 'input', 'output', etc.
Relates to
Related notes
[NAMING, POLICY]{STRICT} SysML: Naming: Always use either anonymous or first letter lower case for Property, ObjectNode and InstanceSpecification names; no exceptions (unless using names to "quote text")! Valid: 'lowerCamelCase' OR 'tla' vs TLA acronym OR 'uCC' vs UpperCamelCase
[NAMING, POLICY, STYLE]{STRONG} The Webel modelling style, naming conventions, and Best Practices for SysML are more consistent than most SysML spec diagrams. When following Webel courses please DO NOT use the spec sample diagrams (which serve a different purpose) as visual references!
[CONVENTION, MODELLING, NAMING, TIP]{STRONG} Webel: If you must name your Ports or Pins, name them simply 'i', 'o', or 'io' (or 'oi') to indicate direction UNLESS you have to indicate a special role like 'iRole', 'oAuxiliary'. DO NOT use Port or Pin names like 'input', 'output', etc.
Related notes (backlinks)
Related snippets (extracts)
Visit also
SysPhS-1.1
Visit also (backlinks)