Icon class icon_class far fa-sticky-note icon_class_computed far fa-sticky-note Note kind CONVENTION NAMING STYLE Policy level STRONG SysMLv1.x keywords FlowProperty FlowDirectionKind FlowDirectionKind::in FlowDirectionKind::inout FlowDirectionKind::out Keywords Webel Best Practice Visit also: Webel Best Practice: "Trust the Port or Pin Type!" - Often the name of the Type of an anonymous Port or Pin is completely sufficient to indicate its role, unless a clear indication of its direction or unique role is required. Webel Best Practice: Webel: If you must name your Ports or Pins, name them simply 'i', 'o', or 'io' 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. Webel: SysML/UML: Dr Darren explains HOWTO use concise 'i'/'o' (input/output) Pin and Parameter naming conventions to promote a signal processing mindset in Activity Diagrams. And HOWTO get them compact. Webel: SysML1.7: Port contract matching is Feature-based, not Type-based. There's nothing particularly magical or special about use of an ~InterfaceBlock on a "conjugating" SysML Port, it's just a convenient way of managing one-to-one Feature matching! Relates to SimpleOpticalTelescope light flow model: staging BDD and context IBD KeplerianRefractor: simple image flow model: staging BDD Related notes [NAMING, POLICY, STYLE]{STRONG} SysML: Webel: "Trust the Type!" - Often the name of the Type of an anonymous Property or instance-level element is completely sufficient to indicate its role - unless multiple Properties of the same Type have different roles within the same owner context! [CONVENTION, MODELLING, NAMING, TIP]{STRONG} Webel: If you must name your Ports or Pins, name them simply 'i', 'o', or 'io' 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. [ASSERTION, MODELLING, PATTERN, TIP]{EXPERIMENTAL} Webel: SysML1.7: Port contract matching is Feature-based, not Type-based. There's nothing particularly magical or special about use of an ~InterfaceBlock on a "conjugating" SysML Port, it's just a convenient way of managing one-to-one Feature matching! Related notes (backlinks) [MODELLING, NAMING, TIP]{STRONG} Webel: SysML: "Really long human friendly element names with spaces make my diagrams easier to read". Dr Darren says "No they don't! Prefer code-like naming (or anonymous for typed elements) wherever possible. Use custom tagged values for other names!" [DISPLAY, MODELLING, NAMING, NAVIGATION, POLICY, SETTINGS, STYLE, TIP, TOOL]{INFORMATIVE} Webel: SysMLv1: Overview of annotated Diagram Slides and Note pages related to general high level SysML modelling principles (some specific to MagicDraw/Cameo). Recommended reading for all Webel SysML/MBSE course attendees. [CONVENTION, MODELLING, NAMING, TIP]{RECOMMENDED} Webel: SysML/UML: Dr Darren explains HOWTO use concise 'i'/'o' (input/output) Pin and Parameter naming conventions to promote a signal processing mindset in Activity Diagrams. And HOWTO get them compact. [MODELLING, NAMING, POLICY]{RECOMMENDED} Webel Parsing Analysis: An anonymous Element may be collected as a /member of a Snippet (it is not important whether collected elements list with a clear name under /member, only that they are traceably elicited). [ASSERTION, MODELLING, NAMING, TIP]{STRICT} Webel: SysML: DO NOT sacrifice modelling naming conventions for the mere sake of carrying organisation-specific names! Instead use tagged values of custom stereotypes as metadata to carry alternative names in parallel with systematic model element names. [CONVENTION, MODELLING, NAMING]{INFORMATIVE} SysML/SysPhS-1.1: Anonymous Property or Action names may not be an option if: You are exporting to Modelica or Simulink; You absolutely need names for generated query reports (such as generated Interface Control Documents). Related snippets (extracts) Visit also Visit also (backlinks) Flags Book traversal links for FlowProperty naming. Use anonymous or just 'i' for in, 'o' for out, and 'io' for inout. "Trust the Type". For conjugation ~InterfaceBlock use 'o' for in, 'i' for out, and 'oi' for inout. Previous Up Next