Learn about Webel IT's new SysMLv2/MBSE Workshop Seminar course!

The AOR Map as SysML Blocks with Rules

Gallery
Tutorial
[TECHNICAL SLIDE TRAIL] The Webel libraries for Wolfram Mathematica: With SysMLv1 models.
Section
SECTION: The Webel '$opt$' and '$arg$' help holder conventions for options and arguments in the Wolfram Language
Topic level
ESSENTIAL
Mathematica keywords
Options
OptionsPattern
List
Association
Webel Mathematica keywords
'$opt$'
'$arg$'
help holder
AOR<||>
aorMap
Keywords
Slide kind
SysML Block Definition Diagram (BDD)
Click on the image to view it full size
Up next
Next trail section
SECTION: A brief look at the Webel W`Base` utilities for Mathematica
Notes
[CONVENTION, MODELLING, NAMING]{RECOMMENDED} Webel: SysML4Mathematica: An '@' prefix in the name of a Block indicates a data structure (such as an Association or List) that does not have a corresponding MTools class or a Webel Abstract Data Type (ADT) "pseudo class" in the Wolfram Language code.
Snippets (quotes/extracts)
Related slides (includes other tutorials)
The AOR Map (Arguments, Options, Rules): Integrated ::usage, HelpF`/HelpO` registration, and Options[] (without MTools)
The AOR Map (Attributes, Options, Rules) Association: Example: aor$f$helpClass
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!
HelpM`: Use Webel MOpt and MArg objects to create ‘$doc$’ Strings for ::usage help
Doc` package ::usage help generation using the docV and docF functions (1)
Doc` package ::usage help generation using the docV and docF functions (2)
Incremental benefit through Doc`, Var`, HelpF`, HelpO`, HelpM`
DRY not WET! "Don't Repeat Yourself!"
Association as SysML: CASE: Webel @RuleMap and @ArgsMap «pseudo» blocks. Very "fiddly" to represent in a SysML Block Definition Diagram!
Association vs Class as SysML CASE: Webel $arg$ and $opt$ help
Association <||> vs Rule
Related slides (backlinks, includes other tutorials)
Registering method options using a Webel AOR (Argument, Options, Rules) Map
Visit also
Visit also (backlinks)