Icon class icon_class far fa-sticky-note icon_class_computed far fa-sticky-note Note kind NAMING POLICY Policy level STRICT UML keywords Port SysMLv1.x keywords Block InterfaceBlock FullPort ProxyPort "standard" Port Keywords SysML Relates to [HISTORICAL] UML-STYLE: Hybrid SUV example: Ports with required/provided Interfaces (Block Definition Diagram) [HISTORICAL] UML-STYLE: Hybrid SUV example: Ports with required/provided Interfaces (Internal Definition Diagram) Hybrid SUV example: provided/required DirectedFeatures (Block Definition Diagram) Hybrid SUV example: provided/required DirectedFeatures (Internal Definition Diagram) BDD overview of entire mini system Webel Radio Net: Conventions, terminology, acronyms Related notes [NAMING, POLICY]{STRONG} Use 'UpperCamelCase' (a.k.a. PascalCase) names for Classifiers such as UML Classes and SysML Blocks) to avoid confusion with 'lowerCase' Property names [see however special naming conventions for acronyms and SysML contract and flow Blocks] [NAMING, POLICY]{STRICT} When using acronyms in names of Classifiers either treat them as a word 'TlaLikeThis' or suffix with an underscore 'TLA_LikeThis', except at the end of the name 'LikeThisTLA' is admissable. Related notes (backlinks) [CONVENTION, MODELLING, NAMING] Block naming: If you find you've got similar blocks named 'Thing' and 'Thing2' then 'Thing' is probably better renamed 'Thing1' [ASSERTION, MODELLING, NAMING, TIP]{INFORMATIVE} [HISTORICAL] SysML: Some users employed the ~ tilde prefix for a conjugated Port type long before it was introduced for ~InterfaceBlock and you MAY use it to name a regular Block that is not an ~InterfaceBlock [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. [NAMING, POLICY]{STRICT} DO NOT use spaces in Property names or Class/Block names! If you want to communicate familiar names of elements within an organisation use a custom stereotype and tagged values (such as 'aka')! [NAMING, POLICY]{STRONG} Webel: For SysML Blocks and InterfaceBlocks used to type Ports with physical flows use 'F_UpperCamelCase' [may be combined with acronymn conventions]. The trailing part (after the underscore '_') may indicate the type that flows. Related snippets (extracts) Visit also Visit also (backlinks) Flags Book traversal links for For SysML Blocks and InterfaceBlocks used to type Ports with contracts use the naming convention 'I_UpperCamelCase' [may be combined with acronymn conventions] Previous Up Next
