Generating UML Sequence Charts - Revision history

Michael Leuschel: /* Specifying the Actors */

2025-05-02T13:01:43Z

Specifying the Actors

← Older revision		Revision as of 13:01, 2 May 2025
Line 72:		Line 72:
	* '''**''' (create an instance of target)		* '''**''' (create an instance of target)
	* '''!!''' (destroy an instance of target)		* '''!!''' (destroy an instance of target)


			A definition like
			<pre>
			SEQUENCE_CHART_ACTORS = [rec(name:"A",kind:"actor",color:"red"),...]
			</pre>
			can be used to define specific actors (actor,boundary,control,entity,database,collections,queue).

	== Example ==		== Example ==

Jan Gruteser: /* Installation and Using */

2025-04-14T13:51:47Z

Installation and Using

← Older revision		Revision as of 13:51, 14 April 2025
Line 3:		Line 3:
	ProB has a new experimental feature to generate a UML sequence chart from the current animation trace using [https://plantuml.com PlantUML].		ProB has a new experimental feature to generate a UML sequence chart from the current animation trace using [https://plantuml.com PlantUML].
	The feature is available in ProB CLI, ProB Tcl/Tk and ProB2-UI.		The feature is available in ProB CLI, ProB Tcl/Tk and ProB2-UI.
	~~With ProB2-UI it is also possible to include a sequence chart in a VisB HTML export.~~
	It currently works for classical B and TLA+ models and you need to copy the [https://plantuml.com/download plantuml.jar] file to ProB's lib folder. The file should be named plantuml.jar (without any version numbers).		It currently works for classical B and TLA+ models and you need to copy the [https://plantuml.com/download plantuml.jar] file to ProB's lib folder. The file should be named plantuml.jar (without any version numbers).

Line 18:		Line 17:

	For ProB2-UI a dialog will pop-up when trying to use the feature giving you instructions on where to put the plantuml.jar file.		For ProB2-UI a dialog will pop-up when trying to use the feature giving you instructions on where to put the plantuml.jar file.
			With ProB2-UI it is also possible to include a sequence chart in a VisB HTML export.

	=== Using the Command ===		=== Using the Command ===

Jan Gruteser: /* Installation and Using */

2025-04-14T13:51:16Z

Installation and Using

← Older revision		Revision as of 13:51, 14 April 2025
Line 3:		Line 3:
	ProB has a new experimental feature to generate a UML sequence chart from the current animation trace using [https://plantuml.com PlantUML].		ProB has a new experimental feature to generate a UML sequence chart from the current animation trace using [https://plantuml.com PlantUML].
	The feature is available in ProB CLI, ProB Tcl/Tk and ProB2-UI.		The feature is available in ProB CLI, ProB Tcl/Tk and ProB2-UI.
			With ProB2-UI it is also possible to include a sequence chart in a VisB HTML export.
	It currently works for classical B and TLA+ models and you need to copy the [https://plantuml.com/download plantuml.jar] file to ProB's lib folder. The file should be named plantuml.jar (without any version numbers).		It currently works for classical B and TLA+ models and you need to copy the [https://plantuml.com/download plantuml.jar] file to ProB's lib folder. The file should be named plantuml.jar (without any version numbers).

Michael Leuschel: /* Using the Command */

2024-09-18T09:18:38Z

Using the Command

← Older revision		Revision as of 09:18, 18 September 2024
Line 29:		Line 29:


	[[file:ProBUMLSeqChartProB2UIDialog.png\|center\|\|~~300px~~]]		[[file:ProBUMLSeqChartProB2UIDialog.png\|center\|\|500px]]

	=== Specifying the Actors ===		=== Specifying the Actors ===

Michael Leuschel: /* Using the Command */

2024-09-18T09:05:55Z

Using the Command

← Older revision		Revision as of 09:05, 18 September 2024
Line 25:		Line 25:

	The UML sequence chart is also available in ProB2-UI in the Graph & Table Visualisation View accessible in the Visualisation menu.		The UML sequence chart is also available in ProB2-UI in the Graph & Table Visualisation View accessible in the Visualisation menu.

			[[file:ProBUMLSeqChartProB2UICmd.png\|center\|\|300px]]


			[[file:ProBUMLSeqChartProB2UIDialog.png\|center\|\|300px]]

	=== Specifying the Actors ===		=== Specifying the Actors ===

Michael Leuschel: /* Installation and Using */

2024-09-18T09:05:24Z

Installation and Using

← Older revision		Revision as of 09:05, 18 September 2024
Line 15:		Line 15:
	Installation complete		Installation complete
	</pre>		</pre>

			For ProB2-UI a dialog will pop-up when trying to use the feature giving you instructions on where to put the plantuml.jar file.

	=== Using the Command ===		=== Using the Command ===

Michael Leuschel: /* Specifying the Actors */

2024-09-18T09:01:26Z

Specifying the Actors

← Older revision		Revision as of 09:01, 18 September 2024
Line 33:		Line 33:
	The definition should either return		The definition should either return
	* the empty string, meaning this operation should be ignored		* the empty string, meaning this operation should be ignored
	* a couple (ActorFrom,ActorTo) specifying the name of the actor sending the message (ActorFrom) and the one receiving the message (ActorTo). You can use strings or other values (which will be converted to strings).		* a couple <tt>(ActorFrom,ActorTo)</tt> specifying the name of the actor sending the message (ActorFrom) and the one receiving the message (ActorTo). You can use strings or other values (which will be converted to strings).
	* a triple (ActorFrom,ArrowStyle,ActorTo), where the actors are like above and ArrowStyle is a string representing a valid plantUML arrow.		* a triple <tt>(ActorFrom,ArrowStyle,ActorTo)</tt>, where the actors are like above and ArrowStyle is a string representing a valid plantUML arrow.
	* a triple (ActorFrom,ArrowStyle,ArrowSuffix,ActorTo), where the actors and arrow style are like above and ArrowSuffix is a string representing a valid plantUML arrow suffix.		* a triple <tt>(ActorFrom,ArrowStyle,ArrowSuffix,ActorTo)</tt>, where the actors and arrow style are like above and ArrowSuffix is a string representing a valid plantUML arrow suffix.
			* a record <tt>rec(from:ActorFrom,to:ActorTo,arrow:ArrowStyle,suffix:ArrowSuffix)</tt>. Note that the arrow fields are optional.

	Currently these arrow styles are supported:		Currently these arrow styles are supported:

Michael Leuschel: /* Using the Command */

2024-09-18T08:59:34Z

Using the Command

← Older revision		Revision as of 08:59, 18 September 2024
Line 18:		Line 18:
	=== Using the Command ===		=== Using the Command ===

	It is available in the Visualize menu:		It is available in the Visualize menu of Tcl/Tk:

	[[file:ProBUMLSeqChartCmd.png\|center\|\|300px]]		[[file:ProBUMLSeqChartCmd.png\|center\|\|300px]]

			The UML sequence chart is also available in ProB2-UI in the Graph & Table Visualisation View accessible in the Visualisation menu.

	=== Specifying the Actors ===		=== Specifying the Actors ===

Michael Leuschel: /* Installation and Using */

2024-09-18T08:53:23Z

Installation and Using

← Older revision		Revision as of 08:53, 18 September 2024
Line 12:		Line 12:
	<pre>		<pre>
	Installing component plantuml from https://github.com/plantuml/plantuml/releases/download/v1.2024.7/		Installing component plantuml from https://github.com/plantuml/plantuml/releases/download/v1.2024.7/
	--> curl -L https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-epl-1.2024.7.jar -o ~~/Users/leuschel/git_root/prob_prolog~~/lib/plantuml.jar		--> curl -L https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-epl-1.2024.7.jar -o .../lib/plantuml.jar
	Installation complete		Installation complete
	</pre>		</pre>

Michael Leuschel: /* Installation and Using */

2024-09-18T08:53:03Z

Installation and Using

← Older revision		Revision as of 08:53, 18 September 2024
Line 12:		Line 12:
	<pre>		<pre>
	Installing component plantuml from https://github.com/plantuml/plantuml/releases/download/v1.2024.7/		Installing component plantuml from https://github.com/plantuml/plantuml/releases/download/v1.2024.7/
	--> ~~/Users/leuschel/opt/miniconda3/bin/~~curl -L https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-epl-1.2024.7.jar -o /Users/leuschel/git_root/prob_prolog/lib/plantuml.jar		--> curl -L https://github.com/plantuml/plantuml/releases/download/v1.2024.7/plantuml-epl-1.2024.7.jar -o /Users/leuschel/git_root/prob_prolog/lib/plantuml.jar
	Installation complete		Installation complete
	</pre>		</pre>