The sigsUp function with OptionsPattern modelled as a SysML Activity (and with "pseudo functional" representation)

This example is from the Webel HelpF` package, which is examined in detail in later slides. The function sigsUp retrieves formatted information on UpValues for a function Symbol 'f'. The Private` helper function z$sigsUD (where Private` is indicated by convention using a 'z$' prefix) can provide information on either UpValues or DownValues, depending on the injected 'fStringsUD' Symbol.

The example shows both regular arguments (in this example including some optional arguments with defaults, so multiplicity [0..1]) and an OptionsPattern[] as a Parameter with the custom Stereotype keyword «M:OptionsPattern».

Options can be represented easily in SysML, and we'll see later how to unpack the OptionsPattern[].

Note also the use of the custom Stereotype keyword «functional» to indicate a pseudo functional representation in SysML. There are limits to how well one can represent functional programming in SysML, but the basic idea of "injection" of a function Symbol can be captured in an informative way.

For reference, some associated Policy Notes (you don't need to visit these links yet):

Webel: Mathematica: CONVENTION: The Stereotype keyword «functional» indicates a "pseudo functional" representation of functional in SysML. There are limits to representation of functional programming in SysML, but it can be informative and is worth doing.

Webel: Mathematica: CONVENTION: A 'z$' prefix may be used to indicate a Private` function or expression within a package or a "private" method of an MTools class or Webel Abstract Data Type (ADT) stateless pseudo class.

Up next

Extract Options from an OptionsPattern[] in a SysML Activity (1)

Notes

[CONVENTION, NAMING, PATTERN, POLICY]{RECOMMENDED} Webel: Mathematica: CONVENTION: The Stereotype keyword «functional» indicates a "pseudo functional" representation of functional in SysML. There are limits to representation of functional programming in SysML, but it can be informative and is worth doing.

[MODELLING, NAMING, TIP]{RECOMMENDED} Webel: SysML4Mathematica: Does every bit of the Mathematica code need to be modelled in SysML? No. Typically just the main function parameters and their interdependencies, data structures, and main code logic. Except for special or educational purposes.

[CONVENTION, MODELLING, NAMING]{RECOMMENDED} Webel: SysML4Mathematica: When modelling the main logic flow of Mathematica code with Activity Diagrams it isn't necessary to model every Mathematica construct. Placeholder Actions, OpaqueActions , and OpaqueBehaviors (as CallBehaviorActions) may be used.

[CONVENTION, NAMING, POLICY]{SUGGESTED} Webel: Mathematica: CONVENTION: A 'z$' prefix may be used to indicate a Private` function or expression within a package or a "private" method of an MTools class or Webel Abstract Data Type (ADT) stateless pseudo class.

[CONVENTION, MODELLING, NAMING]{INFORMATIVE} Webel: SysML4Mathematica: Activity Diagrams used purely for analysis and as development aids are not required to show every ControlFlow, may omit InitialNode and ActivityFinalNode, and are not required to fully validate in SysML tools or execute.

Snippets (quotes/extracts)