|
|
@@ -246,6 +246,8 @@ Action Library
|
|
|
|
|
|
.. rst-class:: table-with-borders
|
|
|
|
|
|
+.. note:: The notion of full types is best explained by example: the full type of a SimpleClassDiagram.Class entity is "/Formalisms/__LanguageSyntax__/SimpleClassDiagram/SimpleClassDiagram/Class".
|
|
|
+
|
|
|
+---------------------------------+-------------------------------------+-------------------------------------------------------------------------------+
|
|
|
| name | parameters | Description |
|
|
|
+=================================+=====================================+===============================================================================+
|
|
|
@@ -262,19 +264,15 @@ Action Library
|
|
|
+---------------------------------+-------------------------------------+-------------------------------------------------------------------------------+
|
|
|
| getAllNodes(_fulltypes) | * *_fulltypes*: list<string> | Return the abstract syntax identifiers of all entities whose types are |
|
|
|
| | | contained within the fulltypes array. If it is omitted, return the abstract |
|
|
|
-| | | syntax identifiers of all entities. The notion of full types is best |
|
|
|
-| | | explained by example: the full type of a SimpleClassDiagram.Class entity is |
|
|
|
-| | | "/Formalisms/__LanguageSyntax__/SimpleClassDiagram/SimpleClassDiagram/Class". |
|
|
|
+| | | syntax identifiers of all entities. |
|
|
|
+---------------------------------+-------------------------------------+-------------------------------------------------------------------------------+
|
|
|
| getNeighbors(_dir[, _type, _id])| * *_dir*: string | Return neighbours of the given entity, specified via its abstract syntax |
|
|
|
-| | * *_type*: string | identifier. The *_dir* parameter can take on three values: "in" implies that |
|
|
|
-| | * *_id*: string | only inbound neighbours should be returned, "out" implies that only outbound |
|
|
|
-| | | neighbours should be returned, "*" implies that neighbours in either |
|
|
|
-| | | direction should be returned. Finally, the *_type* parameter can be set to |
|
|
|
-| | | indicate that only neighbours of the given full type should be re turned. The |
|
|
|
-| | | notion of full types is best explained by example: the full type of a |
|
|
|
-| | | SimpleClassDiagram.Class entity is |
|
|
|
-| | | "/Formalisms/__LanguageSyntax__/SimpleClassDiagram/SimpleClassDiagram/Class". |
|
|
|
+| | * *_type*: string | identifier or __pLabel. The *_dir* parameter can take on three values: "in" |
|
|
|
+| | * *_id*: string | implies that only inbound neighbours should be returned, "out" implies that |
|
|
|
+| | | only outbound neighbours should be returned, "*" implies that neighbours in |
|
|
|
+| | | either direction should be returned. Finally, the *_type* parameter can be |
|
|
|
+| | | set to indicate that only neighbours of the given full type should be |
|
|
|
+| | | returned. |
|
|
|
| | | To match any type, use "*". |
|
|
|
+---------------------------------+-------------------------------------+-------------------------------------------------------------------------------+
|
|
|
| print(msg) | * *msg*: string | Print the given string to the console that launched the AToMPM back-end. |
|
