CATIA Magic

SECTION: The Webel Doc` package and the HelpF`& HelpO` help registry packages

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
Doc` package ::usage help generation using the docV and docF functions (1)
Doc` package ::usage help generation using the docV and docF functions (2)
Why the Webel HelpF` & HelpO` registries?
HelpF`example: helpFunction[$pac$HelpF, addFunction]
HelpF`example: helpPackage[$pac$HelpF]
HelpF`example: addFunction (1)
HelpF`example: addFunction (2)
Generate shared option groups from '$opt$ helper:' the wl$optsFromOpts, docsFromOpts, rulesFromOpts triplet and optsDocsRulesFromOpts (ALIAS odrOpts)
HelpF`: Pull Mathematica Options[] from a Webel HelpF` options superset
HelpF`: Pull Mathematica Options[] for a function registered with addFunction
HelpF`: general query based help
HelpF`: packageFunctionTree[$pac]: Function ::usage help and signatures within a package
HelpF`: Function search by argument number/kind to aid testing automation (1)
HelpF`: Function search by argument number/kind to aid testing automation (2)
HelpF`: Simple package function DownValues vs ::usage checker
HelpF`: Simple function DownValues inspector GUI: gui$helpDownStrings
HelpF`: gui$helpDownStrings signature display modes
The Webel HelpO`package class and method registry
HelpO`: addClass: Register an MTools class by fully qualified package name
HelpO`: addMethod: MTools method registration example for the Webel MAll class and an object
HelpO`: Part of the help registry for the Webel MAll universal MTools class and some methods
HelpO`: Find help on a method of a Webel MAll universal class object
HelpM`: Using the MFunction and MMethod helper classes with MArg & MOpt
HelpM`: Using the Webel MFunction class and MArg & MOpt with HelpF`
HelpM`: Using the Webel MMethod class and MArg & MOpt with HelpO`
HelpM: Use MFunction and MMethod with MArg & MOpt for ::usage (and consistent with the HelpF` and HelpO` registries)
HelpM`: Using the Webel MClass helper with the MMethod helper and the HelpO` help registry
HelpM`: Using the Webel MPackage helper with MFunction and MClass and the HelpF` and HelpO` help registries
Incremental benefit through Doc`, Var`, HelpF`, HelpO`, HelpM`

SECTION: The Webel '$opt$' and '$arg$' help holder conventions for options and arguments in the Wolfram Language

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
The Webel '$opt$', 'rule$opt$', '$arg$', 'rule$arg$' and supporting '$k$' conventions for "help holders"
The Webel $opt$ options "help holder" convention
Examples of Webel $opt$ with qualifiers
Webel $opt$ options help by function: Example: tableFunctionOptions[f]
Cleaner Options declarations!
Webel '$arg$' and '$opt$' support via the Doc` package
Functions from the W`Base`Doc` package
Make a Webel option help Rule relying on ‘$opt$’ naming conventions
Webel ‘$arg$’, ‘def$arg$’, and ‘rule$arg$’ convention
Make a Webel help Rule for a required ‘$arg$’ argument + conventions
Make a Webel argument help Rule with a default by convention OR override
Webel $arg$ convention help consistency checks
Webel ‘rule$arg$’ convention help consistency checks
Generate $doc$arg$ and $doc$opt$ Strings from Webel help Rules for use in ::usage
When to use explicit $arg$ help holders (in lower level utility packages)
Why not just generate all the '$arg$' and '$opt$' help holders (using ToExpression)?
Why not just use the Entity system for '$arg$' and '$opt$' help holders?
Association vs Class as SysML CASE: Webel $arg$ and $opt$ help
Association as SysML: CASE: Webel @RuleMap and @ArgsMap «pseudo» blocks. Very "fiddly" to represent in a SysML Block Definition Diagram!
Association as SysML: CASE: Webel @ArgMap «pseudo» block (slightly less "fiddly" as an Internal Block Diagram)
Easier ‘$arg$’ and ‘$opt$’ help Rules using the Webel MArg and MOpt helper classes and MTools for OO
Webel ‘$arg$’ help is much easier with the MArg class using MTools!
Webel ‘$opt$’ help is much easier with the MOpt class using MTools!
Webel ‘$opt$’ help even easier with makeOpt[$name] for MOpt!
Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help
SysML: OptionsPattern[] “Generalizations” using Join:" Example: HelpM` helper classes new functions

SECTION: A brief look at the Webel W`Base` utilities for Mathematica

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
The Webel W`Base`«M:Project» and «M:Paclet»
Overview of Webel utility W`Base` packages as SysMLv1 Blocks
Overview of Webel utilities W`Base` packages as SysML Usages
Detailed overview of Webel utilities W`Base` packages with usages
Webel W`Base` vs Git repository and Wolfram Player Pro encoded version
Some Webel Devel` package functions
Diagnostic message Print output switching between Mathematica and Wolfram Player Pro
The Webel ‘$pac$’ convention and DEVEL loading echo diagnostics
Devel` package: check Function Symbol against ::usage
Devel` functions for ExpressionTree (basic)
Some Webel Utility` package functions
Utility`package: stripOpt and stripOpts Delegating subsets of Options
Some Webel Display` package functions
The Webel ManGUI` package utilities for Manipulate GUIs
The Webel ManGUI` package $man$ option aliases
Webel ManGUI` examples: man$bool and man$group$pane
The Webel W`Moo` package group: Additional utilities for the user-contributed MTools paclet for classes & object orientation
Deployment folders for projects that depend on W`Base` and MTools OO (as SysML)

SECTION: Webel coding and naming conventions for the Wolfram Language

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
DRY not WET! "Don't Repeat Yourself!"
The Webel ‘$’ prefix convention for Strings and "String similar" Wolfram Language code
The Webel $k$ prefix convention for Association String keys
The Webel ‘$pat$’ pattern helper convention for frequently used Patterns
The Webel ‘$t$’ “pseudo type” indicator String convention (for optional additional documentation only)
Webel ‘$info$f$’ prefix convention for function help holder Strings
Webel ‘def$’ DRY default capture! Applicable to arguments and options.

SECTION: Modelling the Wolfram Language in SysMLv1 and related Webel coding conventions

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
Modelling the Wolfram Language in SysML and SysML-friendly coding conventions.
Basic SysMLv1 example: The HelpM` package MTools classes as Blocks
SysML Stereotypes and icons used for Mathematica and Wolfram technologies
Wolfram Language vs SysMLv1
Parameter types in most SysML tools
Explicit vs implicit representation of expressions in SysML4Mathematica
Webel SysML4Mathematica: Some Wolfram Language Heads as SysMLv1 Blocks and ValueTypes
Concise {} for List and <||> for Association
Frequently used typed {} Lists
Frequently used String pair Lists
Association <||> vs Rule
Typed Association example: <||>$* maps String to any expression
“Active” OpaqueBehaviors corresponding to block Heads: Used in CallBehaviorActions
“Chained” Head and OpaqueBehavior Convenient for frequently used combinations
Example: Representation of a Webel MAll class MTools method as a SysML Activity Diagram
SysML Activities as function networks (simple contrived Real maths example)
SysML/UML ExpansionRegion for iteration (as adapted for use with Mathematica)
SysML Activity with @pseudo functions capturing Wolfram Language logic
The sigsUp/Down functions as a SysML BDD: With Options Block and pseudo functional indicators
The sigsUp function with OptionsPattern modelled as a SysML Activity (and with "pseudo functional" representation)
Extract Options from an OptionsPattern[] in a SysML Activity (1)
Extract Options from an OptionsPattern[] in a SysML Activity (2) DETAILED
About «pseudo» blocks (always prefixed with ‘@’)

SECTION: The Webel Mathematica libraries - INTRODUCTION - And the role of SysML

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
DISCLAIMERS & CONCERNING TRADEMARKS
About the author
About this slide set
About use of Wolfram Language code
About use of SysML Diagrams
A word on classes and object orientation for Mathematica
Representing the SysMLv1 Block and SysMLv2 Part Def in Mathematica requires classes and object orientation (OO)
SysMLv1 vs SysMLv2
Main topics & sections
HOW not WHAT!
It’s rather technical!

[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysML4 Mathematica (SysMLv1) models.

Jump to first slide
DISCLAIMERS & CONCERNING TRADEMARKS
SECTION: The Webel Mathematica libraries - INTRODUCTION - And the role of SysML
SECTION: Modelling the Wolfram Language in SysMLv1 and related Webel coding conventions
SECTION: Webel coding and naming conventions for the Wolfram Language
SECTION: The Webel '$opt$' and '$arg$' help holder conventions for options and arguments in the Wolfram Language
SECTION: A brief look at the Webel W`Base` utilities for Mathematica
SECTION: The Webel Doc` package and the HelpF`& HelpO` help registry packages
SECTION: The Webel Var` package Entity-based variable registry

Context and structural model for the RadioNet, NetSession, and RadioStation

[TRAIL] SysMLv1: The Webel Radio Net port-based messaging example model in Cameo Systems Modeler and Cameo Simulation Toolkit

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
Webel Radio Net: The 'RadioNetContext' system context as both an IBD and a BDD
Webel Radio Net: 'structure' SysML Package Diagram
Webel Radio Net: 'channel' SysML Package Diagram
Webel Radio Net: 'net' SysML Package Diagram with the 'RadioNet' system
Webel Radio Net: Focus BDD for block 'NetSession'
Webel Radio Net: 'NetSession' Activities overview
Webel Radio Net: Focus BDD for block 'SessionLog'

Webel Radio Net: Model overview, exchange items, and Ports

[TRAIL] SysMLv1: The Webel Radio Net port-based messaging example model in Cameo Systems Modeler and Cameo Simulation Toolkit

Slides in this section

If you want to navigate the entire section including the additional explanatory text click on the title link of the first slide to view the full slide page, then use the next links to move through the slide pages. If you just want to view the slide images only in sequence, click on any slide to view it larger in a viewer, then click again to move through each slide in this tutorial trail section.
Webel Radio Net: Conventions, terminology, acronyms
Webel Radio Net: SysML Package Diagram as index
Webel Radio Net: Content Diagram as index of table and matrix diagrams
Webel Radio Net: 'value' SysML Package Diagram with custom ValueTypes and Units
Webel Radio Net: 'exchange' SysML Package Diagram with Signals (and Port types)
Webel Radio Net: 'scheduling' SysML Package Diagram with scheduling message Signal families (and Port types)
Webel Radio Net: Focus BDD of the 'InitSession' scheduling Signal and its special role in a net session
Webel Radio Net: 'message' SysML Package Diagram with Message block "packet" and '$msg' String
Webel Radio Net: 'radio' SysML Package Diagram with high level view of Port types for 'Radio' Signals
Webel Radio Net: The RadioMessage Signals
Webel Radio Net: Focus BDD for the SessionSpec exchange item (and the NetManager)

[EXTERNAL LINKS] Cameo Simulation Toolkit (aka Magic Model Analyst) videos and guides

Keywords

Keywords

A collection of EXTERNAL links (scroll down) to videos, slides, and other guides on Magic Model Analyst® (Cameo Simulation Toolkit®). These links are included here as additional resources and do not replace the Webel IT Australia online SysML/MBSE educational resources or the Webel training course materials:

[EXTERNAL LINKS] SysMLv1/UML: MagicDraw/Cameo: Derived properties, structured expressions, reusing opaque behaviours, metachain

Keywords

Keywords

There is now a Webel trail on how to handle specific Derived Property cases!
[STUB] SysMLv1: MagicDraw/Cameo: SPECIFIC CASES of Structured Expressions, Derived Properties, Custom Scripts, and Metachain Navigation for table columns

About the EXTERNAL links

Links to external resources are provided by Webel IT Australia without any guarantees concerning their accuracy or suitability for pract

Webel SE: pragmatic tool-friendly functional analysis: 2-level drill-down from a single Use Case via a «scenario» Activity with allocation to «logical» subsystems first then crossing to the «design» Blocks zone.

Gallery
Tutorial
[STUB] TRAIL: Webel's ultimate guide to simplified yet adequate pragmatic systems engineering with functional analysis in SysMLv1 for smaller scale MBSE projects in the MagicDraw/Cameo/CATIA Magic tools
Section
Slide kind
diagram
SysML Activity Diagram
SysML Block Definition Diagram (BDD)
SysML Internal Block Diagram (IBD)
SysML Package Diagram
SysML UseCase Diagram

SysML/MBSE: Cameo/MagicDraw: MagicGrid® and the MagicGrid® Book of Knowledge: A pragmatic review of some selected aspects by Dr Darren of Webel IT Australia

Keywords

Keywords

Webel IT's summaries of MagicGrid® for SysML/MBSE with Cameo are offered for the interest of MagicGrid users for informative and educational purposes only.
  [UML-2.5.1] CallBehaviorAction::behavior : Behavior [1..1] ... The Behavior being invoked.

The Webel Recipe for SysML-friendly Wolfram Language coding in Mathematica

Keywords

Keywords

As part of a long term project developed, initially during work for a client, Webel IT Australia in partnership with GreenSoft Pty Ltd is developing a very complex Mathematica application with substantial SysML modelling support.

No Magic Inc vs Dassault Systèmes 3DS CATIA Magic product names for UML/SysML tools

Keywords

Keywords

No Magic Inc., the original developers of the MagicDraw/Cameo tools for Unified Modeling Language (UML®) and Systems Modeling Language v1 (SysML®) - were acquired in 2017/2018 by Dassault Systèmes, and the MagicDraw/Cameo family of software tools have been rebranded.

CATIA Magic zone

Keywords

Keywords

In 2018, Dassault Systèmes acquired No Magic Inc, the developers of the MagicDraw/Cameo family of software products for Unified Modeling Language (UML®) and Systems Modeling Language v1 (SysML®), which included including: MagicDraw® UML, MagicDraw SysML Plugin, Magic Cyber-Systems Engineer ® (Cameo Systems

MEMKO Systems

MEMKO Systems has been appointed by Dassault Systèmes (who acquired No Magic in 2018) as the CATIA No Magic Value Solutions Partner and Reseller for Australia and New Zealand.

Course: Model-Based Systems Engineering with the OMG's Systems Modeling Language® (v1) and the MagicDraw/Cameo (CATIA Magic™) tools for SysML

Keywords

Keywords

Webel IT Australia is an OMG-Accredited Training Provider for SysML!
We are offering a 30% discount off all SysML/MBSE course bookings secured by 31st August 2024!
Subscribe to CATIA Magic
© Copyright 2000 - 2024 Webel IT Australia (WEBEL.COM.AU) (ABN 67 677 268 579). All rights reserved.
Excluded: Text from OMG™ specifications parsed into UML™ and SysML™ analysis models remains © Copyright The Object Management Group™.
Excluded: Text from Wikipedia articles quoted for educational purposes is subject to the Wikipedia Creative Commons Attribution ShareAlike Licence
Excluded: Text from Java™ tutorials and documentation - parsed into UML™ analysis models - remains © Copyright Oracle
UML® is a registered trademark of the Object Management Group.
SysML® is a registered trademark of the Object Management Group.
OMG® is a registered trademark of the Object Management Group.