diff --git a/build_docu.ps1 b/build_docu.ps1 index 1d1d71b4d..1f7a4734b 100644 --- a/build_docu.ps1 +++ b/build_docu.ps1 @@ -1,4 +1,6 @@ # dotnet run --project ..\ix\src\ix.compiler\src\ixd\Ix.ixd.csproj --framework net7.0 -x .\src\core\ctrl\ -o .\docfx\apictrl\ -dotnet ixd -x .\src\core\ctrl\ -o .\docfx\apictrl\ -dotnet docfx .\docfx\docfx.json +dotnet ixd -x .\src\core\ctrl\ -o .\docfx\apictrl\core\ +dotnet ixd -x .\src\messaging\ctrl\ -o .\docfx\apictrl\messaging\ +dotnet ixd -x .\src\abstractions\ctrl\ -o .\docfx\apictrl\abstractions\ +dotnet docfx .\docfx\docfx.json --debug dotnet docfx serve .\docs\ diff --git a/docfx/articles/messaging/AXOMESSENGER.md b/docfx/articles/messaging/AXOMESSENGER.md new file mode 100644 index 000000000..86bc8c818 --- /dev/null +++ b/docfx/articles/messaging/AXOMESSENGER.md @@ -0,0 +1,55 @@ +# AxoMessenger + +Static `AxoMessenger` is a class that provides mechanism for delivering static message to the supervising applications (SCADA/HMI). This static messenger uses the text defined in the declaration. This text cannot be changed during runtime as the text is "transfered" just once during the compilation and it is not read during the runtime. The PLC code of the `AxoMessenger` just ensures the activation, deactivation and acknowledgement of the message. + +`AxoMessenger` contains following public methods. + +`Serve()` - this method must be called cyclically. It ensures the inicialization of the instance, so as the deactivation of the message. + +```mermaid + classDiagram + class AxoMessenger{ + +Serve(IAxoContext _context) + +Serve(IAxoObject _object) + } +``` + +`Activate(category)` - this method immediatelly activate the message of the category where category is of the type `eAxoMessageCategory`. Deactivation is detected after one PLC cycle without calling the method `Activate`. + +`ActivateOnCondition(condition,category)` - this method activate the message of the category where category is of the type `eAxoMessageCategory` on the rising edge of the condition and imidiatelly deactivate the message on the falling edge of the condition. The `ActivateOnCondition` method is designed to be called cyclically. + +>[!NOTE] +>Do not use the both activation methods on the same `AxoMessenger` instance, please use just one of them. + +`Acknowledge()` - acknowledge the message if required. The message could be acknowledged so as before deactivation so as after. + +Depending on the [eAxoMessageCategory](/apictrl/abstractions/plc.AXOpen.Messaging.eAxoMessageCategory.html) the messenger should require the acknowledgement. + +By default the acknowledgement is not required for the levels `Trace`,`Debug`,`Info`,`TimedOut`,`Notification` and `Warning`. +This could be overwritten by calling the `RequireAcknowledgement()` method. +Contrariwise, the acknowledgement is required for the levels `Error`,`ProgrammingError`,`Critical`,`Fatal` and `Catastrophic` by default. This could be overwritten by calling the `DoNotRequireAcknowledgement()` method. + +**Attributes `MessageText` and `Help`** + +These attributes are used to set the values of the static texts of the messenger. These values are read out at the compilation time transfered to .NET counterpart and set as a constant strings. Therefore they can't be changed at the runtime. + +Example of declaration the instance and defining the attributes `MessageText` and `Help`. +[!code-smalltalk[](../../../src/integrations/ctrl/src/Examples/AXOpen.Messaging/AxoStaticMessengerDocuExample.st?range=7-9)] + +**How to use `AxoMessenger`** + +The instance of the `AxoMessenger` must be defined inside the `AxoContext` or `AxoObject`. +Inside the `Main()` method of the related `AxoContext` or inside the cyclically called method of the `AxoObject` following rules must be applied. The `Serve()` method of the instance of the `AxoMessenger` must be called cyclically. +The `Activate` method should be used called the required condition or the `AcitvateOnCondition` should be called cyclically. Avoid to mix using the both methods with the same instance. +[!code-smalltalk[](../../../src/integrations/ctrl/src/Examples/AXOpen.Messaging/AxoStaticMessengerDocuExample.st?range=5-25,48)] + +If neccessary, the default behaviour of the acknowledgeable messenger should be changed as follows. +[!code-smalltalk[](../../../src/integrations/ctrl/src/Examples/AXOpen.Messaging/AxoStaticMessengerDocuExample.st?name=DoNotRequireAcknowledgement)] +Contrariwise, the default behaviour of the unacknowledgeable messenger should be changed as follows. +[!code-smalltalk[](../../../src/integrations/ctrl/src/Examples/AXOpen.Messaging/AxoStaticMessengerDocuExample.st?name=RequireAcknowledgement)] + +**How to visualize `AxoMessenger`** + +On the UI side use the `RenderableContentControl` and set its Context according the placement of the instance of the `AxoMessenger`. +[!code-csharp[](../../../src/integrations/src/AXOpen.Integrations.Blazor/Pages/DocuExamples/AxoMessagingStaticDocu.razor?name=RenderedView)] + diff --git a/docfx/articles/messaging/README.md b/docfx/articles/messaging/README.md new file mode 100644 index 000000000..97edface6 --- /dev/null +++ b/docfx/articles/messaging/README.md @@ -0,0 +1,7 @@ +# **AXOpen.Messaging** + +**AXOpen.Messaging** provides basic blocks for providing messaging. + +# Basic concepts + +[!INCLUDE [AxoMessenger](AXOMESSENGER.md)] diff --git a/docfx/articles/toc.yml b/docfx/articles/toc.yml index c0b40c2cd..bddcf2207 100644 --- a/docfx/articles/toc.yml +++ b/docfx/articles/toc.yml @@ -24,4 +24,9 @@ - name: AxoComponent href: ~/articles/core/AXOCOMPONENT.md - name: AXOpen.Data - href: ~/articles/data/README.md \ No newline at end of file + href: ~/articles/data/README.md +- name: AXOpen.Messaging + href: ~/articles/messaging/README.md + items: + - name: AxoMessenger + href: ~/articles/messaging/AXOMESSENGER.md \ No newline at end of file diff --git a/docfx/docfx.json b/docfx/docfx.json index f256f862d..15e7543fa 100644 --- a/docfx/docfx.json +++ b/docfx/docfx.json @@ -2,10 +2,12 @@ "metadata": [ { "src": [ - { + { "files": [ + "abstractions/src/**.csproj", "core/src/**.csproj", - "data/src/**.csproj" + "data/src/**.csproj", + "messaging/src/**.csproj" ], "exclude": [ "**Test*.csproj", diff --git a/src/abstractions/ctrl/apax.yml b/src/abstractions/ctrl/apax.yml index c0ee11561..32cb9fbab 100644 --- a/src/abstractions/ctrl/apax.yml +++ b/src/abstractions/ctrl/apax.yml @@ -1,5 +1,5 @@ name: "@ix-ax/axopen.abstractions" -version : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' +version : '0.1.4-83-Add-documentation-for-AxoMessenger.65' type: lib targets: - "1500" diff --git a/src/core/ctrl/apax.yml b/src/core/ctrl/apax.yml index 30fd8ff81..229d0ca05 100644 --- a/src/core/ctrl/apax.yml +++ b/src/core/ctrl/apax.yml @@ -1,5 +1,5 @@ name: "@ix-ax/axopen.core" -version : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' +version : '0.1.4-83-Add-documentation-for-AxoMessenger.65' type: lib targets: # - "1500" @@ -15,6 +15,6 @@ scripts: - dotnet ixc dependencies: "@ax/system-timer": 3.0.9 - "@ix-ax/axopen.abstractions" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' + "@ix-ax/axopen.abstractions" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' "@ax/axunit-library": ^4.0.6 diff --git a/src/data/ctrl/apax.yml b/src/data/ctrl/apax.yml index a93f107b1..c6b019258 100644 --- a/src/data/ctrl/apax.yml +++ b/src/data/ctrl/apax.yml @@ -1,5 +1,5 @@ name: "@ix-ax/axopen.data" -version : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' +version : '0.1.4-83-Add-documentation-for-AxoMessenger.65' type: lib targets: # - "1500" @@ -8,7 +8,7 @@ targets: files: - src dependencies: - "@ix-ax/axopen.core" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' + "@ix-ax/axopen.core" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' "@ax/axunit-library": ^4.0.6 devDependencies: "@ax/sdk": 3.0.18 diff --git a/src/integrations/ctrl/apax.yml b/src/integrations/ctrl/apax.yml index 36d7ff97e..4d5e2e5b7 100644 --- a/src/integrations/ctrl/apax.yml +++ b/src/integrations/ctrl/apax.yml @@ -1,5 +1,5 @@ name: "axopen.integrations" -version : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' +version : '0.1.4-83-Add-documentation-for-AxoMessenger.65' type: app targets: # - "1500" @@ -11,11 +11,11 @@ devDependencies: "@ax/sld": ^0.14.2 dependencies: - "@ix-ax/axopen.core" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' - "@ix-ax/axopen.data" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' - "@ix-ax/axopen.probers" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' - "@ix-ax/axopen.messaging" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' - "@ix-ax/axopen.simatic1500" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' + "@ix-ax/axopen.core" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' + "@ix-ax/axopen.data" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' + "@ix-ax/axopen.probers" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' + "@ix-ax/axopen.messaging" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' + "@ix-ax/axopen.simatic1500" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' "@ax/axunit-library" : ^4.0.6 variables: diff --git a/src/integrations/ctrl/src/Examples/AXOpen.Messaging/AxoStaticMessengerDocuExample.st b/src/integrations/ctrl/src/Examples/AXOpen.Messaging/AxoStaticMessengerDocuExample.st new file mode 100644 index 000000000..77287fc2d --- /dev/null +++ b/src/integrations/ctrl/src/Examples/AXOpen.Messaging/AxoStaticMessengerDocuExample.st @@ -0,0 +1,49 @@ +USING AXOpen.Messaging; +USING AXOpen.Messaging.Static; + +NAMESPACE AxoStaticMessengerDocuExample + CLASS Messengers EXTENDS AXOpen.Core.AxoContext + VAR PUBLIC + {#ix-set:MessageText = "<#Message text for messenger 1#>"} + {#ix-set:Help = "<#Help text for messenger 1#>"} + _messenger1 : AxoMessenger; + _messenger1condition : BOOL; + {#ix-set:MessageText = "<#Message text for messenger 2#>"} + {#ix-set:MessageText = "<#Message text for messenger 2#>"} + _messenger2 : AxoMessenger; + _messenger2condition : BOOL; + END_VAR + + METHOD PROTECTED OVERRIDE Main + _messenger1.Serve(THIS); + IF _messenger1condition THEN + _messenger1.Activate(eAxoMessageCategory#Error); + END_IF; + + _messenger2.Serve(THIS); + _messenger2.ActivateOnCondition(_messenger2condition,eAxoMessageCategory#Warning); + END_METHOD + + METHOD Examples + // + _messenger1.Serve(THIS); + IF _messenger1condition THEN + _messenger1.Activate(eAxoMessageCategory#Error); + END_IF; + // + + // + _messenger2.Serve(THIS); + _messenger2.ActivateOnCondition(_messenger2condition,eAxoMessageCategory#Warning); + // + + // + _messenger2.ActivateOnCondition(_messenger2condition,eAxoMessageCategory#Warning).RequireAcknowledgement(); + // + + // + _messenger2.ActivateOnCondition(_messenger2condition,eAxoMessageCategory#Error).DoNotRequireAcknowledgement(); + // + END_METHOD + END_CLASS +END_NAMESPACE diff --git a/src/integrations/ctrl/src/configuration.st b/src/integrations/ctrl/src/configuration.st index 0d61b2127..c417446e5 100644 --- a/src/integrations/ctrl/src/configuration.st +++ b/src/integrations/ctrl/src/configuration.st @@ -22,6 +22,7 @@ CONFIGURATION MyConfiguration AxoMomentaryTaskDocu : AxoMomentaryTaskExamples.AxoMomentaryTaskDocuExample; AxoDataExamplesDocu : AxoDataExamplesDocu.Context; AxoMessengers : AxoStaticMessengerExample.Messengers; + AxoMessengersDocu : AxoStaticMessengerDocuExample.Messengers; AxoRtc : AxoRtc.AxoS71500Rtc; process_data_manager: AxoDataExamples.AxoProcessDataManager; diff --git a/src/integrations/ctrl/src/program.st b/src/integrations/ctrl/src/program.st index 74e745e9d..8e024564f 100644 --- a/src/integrations/ctrl/src/program.st +++ b/src/integrations/ctrl/src/program.st @@ -19,6 +19,7 @@ PROGRAM MyProgram AxoDataExamplesDocu : AxoDataExamplesDocu.Context; AxoMessengers : AxoStaticMessengerExample.Messengers; + AxoMessengersDocu : AxoStaticMessengerDocuExample.Messengers; // Integration test Integrations : IntegrationTests.Integrations; @@ -42,7 +43,8 @@ PROGRAM MyProgram AxoDataExamplesDocu.Run(); AxoMessengers.Run(); AxoMessengers.InjectRtc(AxoRtc); - + AxoMessengersDocu.Run(); + AxoMessengersDocu.InjectRtc(AxoRtc); // Integration tests diff --git a/src/integrations/src/AXOpen.Integrations.Blazor/Pages/DocuExamples/AxoMessagingStaticDocu.razor b/src/integrations/src/AXOpen.Integrations.Blazor/Pages/DocuExamples/AxoMessagingStaticDocu.razor new file mode 100644 index 000000000..918981695 --- /dev/null +++ b/src/integrations/src/AXOpen.Integrations.Blazor/Pages/DocuExamples/AxoMessagingStaticDocu.razor @@ -0,0 +1,35 @@ +@page "/AxoMessagingStaticDocu" +@using axopen_integrations +@using AXOpen.Core; +

AxoMessagingStaticDocu

+ +
+
+
+
Simple static messages examples.
+
+
+
+
+
+
+ // + + // +
+
+ +
+
+ +
+
+ +
+
+
+
+
+
+
+ diff --git a/src/integrations/src/AXOpen.Integrations.Blazor/Pages/DocuExamples/DocuExamples.razor b/src/integrations/src/AXOpen.Integrations.Blazor/Pages/DocuExamples/DocuExamples.razor index 7edd7e3e5..88dad4faf 100644 --- a/src/integrations/src/AXOpen.Integrations.Blazor/Pages/DocuExamples/DocuExamples.razor +++ b/src/integrations/src/AXOpen.Integrations.Blazor/Pages/DocuExamples/DocuExamples.razor @@ -24,5 +24,10 @@ AxoDataExamplesDocu +
+ + AxoMessagingStaticDocu + +
diff --git a/src/messaging/ctrl/apax.yml b/src/messaging/ctrl/apax.yml index 39dd29d11..ff0932ca1 100644 --- a/src/messaging/ctrl/apax.yml +++ b/src/messaging/ctrl/apax.yml @@ -1,5 +1,5 @@ name: "@ix-ax/axopen.messaging" -version : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' +version : '0.1.4-83-Add-documentation-for-AxoMessenger.65' type: lib targets: # - "1500" @@ -14,7 +14,7 @@ scripts: postbuild: - dotnet ixc dependencies: - "@ix-ax/axopen.core" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' - "@ix-ax/axopen.utils" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' - "@ix-ax/axopen.abstractions" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' + "@ix-ax/axopen.core" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' + "@ix-ax/axopen.utils" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' + "@ix-ax/axopen.abstractions" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' "@ax/axunit-library": ^4.0.6 diff --git a/src/messaging/ctrl/src/Dynamic/AXOpenMessaging/AxoMessenger.st b/src/messaging/ctrl/src/Dynamic/AXOpenMessaging/AxoMessenger.st index ae152c36e..19b1dc6a4 100644 --- a/src/messaging/ctrl/src/Dynamic/AXOpenMessaging/AxoMessenger.st +++ b/src/messaging/ctrl/src/Dynamic/AXOpenMessaging/AxoMessenger.st @@ -20,7 +20,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// /// /// - CLASS AxoMessenger (*EXTENDS AxoObject*) IMPLEMENTS IAxoMessenger, IAxoMessageProperties, IAxoMessageTextBuilder, IAxoMessageCategorize, IAxoMessages + CLASS AxoMessenger (*EXTENDS AxoObject*) IMPLEMENTS IAxoMessenger, AXOpen.Messaging.Dynamic.IAxoMessageProperties, IAxoMessageTextBuilder, IAxoMessageCategorize, IAxoMessages VAR /// /// Most important message of this instance of messenger; stores the most important message from the last context cycle. @@ -60,42 +60,42 @@ NAMESPACE AXOpen.Messaging.Dynamic /// /// Categorizes and creates the message as 'debug'. /// - METHOD PUBLIC AsDebug : IAxoMessageProperties + METHOD PUBLIC AsDebug : AXOpen.Messaging.Dynamic.IAxoMessageProperties AsDebug := THIS.Post(THIS.StringBuilder()^.AsString(), eAxoMessageCategory#Debug); END_METHOD /// /// Categorizes and creates the message as 'error'. /// - METHOD PUBLIC AsError : IAxoMessageProperties + METHOD PUBLIC AsError : AXOpen.Messaging.Dynamic.IAxoMessageProperties AsError := THIS.Post(THIS.StringBuilder()^.AsString(), eAxoMessageCategory#Error); END_METHOD /// /// Categorizes and creates the message as 'fatal'. /// - METHOD PUBLIC AsFatal : IAxoMessageProperties + METHOD PUBLIC AsFatal : AXOpen.Messaging.Dynamic.IAxoMessageProperties AsFatal := THIS.Post(THIS.StringBuilder()^.AsString(), eAxoMessageCategory#Fatal); END_METHOD /// /// Categorizes and creates the message as 'information'. /// - METHOD PUBLIC AsInfo : IAxoMessageProperties + METHOD PUBLIC AsInfo : AXOpen.Messaging.Dynamic.IAxoMessageProperties AsInfo := THIS.Post(THIS.StringBuilder()^.AsString(), eAxoMessageCategory#Info); END_METHOD /// /// Categorizes and creates the message as 'trace'. /// - METHOD PUBLIC AsTrace : IAxoMessageProperties + METHOD PUBLIC AsTrace : AXOpen.Messaging.Dynamic.IAxoMessageProperties AsTrace := THIS.Post(THIS.StringBuilder()^.AsString(), eAxoMessageCategory#Trace); END_METHOD /// /// Categorizes and creates the message as 'warning'. /// - METHOD PUBLIC AsWarning : IAxoMessageProperties + METHOD PUBLIC AsWarning : AXOpen.Messaging.Dynamic.IAxoMessageProperties AsWarning := THIS.Post(THIS.StringBuilder()^.AsString(), eAxoMessageCategory#Warning); END_METHOD @@ -103,7 +103,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// Adds message of 'catastrophic' category to the message queue. /// Use this category when there is a situation when the device cannot continue operations due to irrecoverable failure. /// - METHOD PUBLIC Catastrophic : IAxoMessageProperties + METHOD PUBLIC Catastrophic : AXOpen.Messaging.Dynamic.IAxoMessageProperties VAR_INPUT /// /// Arbitrary message string. @@ -117,7 +117,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// Adds message of 'critical' category to the message queue. /// Use this category when a critical error occured, that is not recoverable by the means of software (reset/restore) and a detailed inspection is required. /// - METHOD PUBLIC Critical : IAxoMessageProperties + METHOD PUBLIC Critical : AXOpen.Messaging.Dynamic.IAxoMessageProperties VAR_INPUT /// /// Arbitrary message string. @@ -131,7 +131,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// Adds message of 'debug' category to the message queue. /// Use when you need to report debug information for you as programmer. /// - METHOD PUBLIC Debug : IAxoMessageProperties + METHOD PUBLIC Debug : AXOpen.Messaging.Dynamic.IAxoMessageProperties VAR_INPUT /// /// Arbitrary message string. @@ -147,7 +147,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// to deliver expected result. /// Do not use this category to report information about failed process like measurement or detection. /// - METHOD PUBLIC Error : IAxoMessageProperties + METHOD PUBLIC Error : AXOpen.Messaging.Dynamic.IAxoMessageProperties VAR_INPUT /// /// Arbitrary message string. @@ -161,7 +161,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// Adds message of 'information' category to the message queue. /// Use when you want to deliver information to the user, that has only informative character and does not adversely affect a process. /// - METHOD PUBLIC Info : IAxoMessageProperties + METHOD PUBLIC Info : AXOpen.Messaging.Dynamic.IAxoMessageProperties VAR_INPUT /// /// Arbitrary message string. @@ -175,7 +175,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// Adds message of 'notification' category to the message queue. /// Use this category when you want to report a notification that may be of interest to the user, but does not adveresly affect a process. /// - METHOD PUBLIC Notify : IAxoMessageProperties + METHOD PUBLIC Notify : AXOpen.Messaging.Dynamic.IAxoMessageProperties VAR_INPUT /// /// Arbitrary message string. @@ -189,7 +189,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// Adds message of 'programming error' category to the message queue. /// Use this category to inform about a possible programming error, defect in settings or missing information at a level of programming or system or process settings. /// - METHOD PUBLIC Programming : IAxoMessageProperties + METHOD PUBLIC Programming : AXOpen.Messaging.Dynamic.IAxoMessageProperties VAR_INPUT /// /// Arbitrary message string. @@ -204,7 +204,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// Use when you need to track detailed information about internal states of the program for detailed visibility. /// This is lowest level of category that can be used in production, for detailed observation of PLC program. /// - METHOD PUBLIC Trace : IAxoMessageProperties + METHOD PUBLIC Trace : AXOpen.Messaging.Dynamic.IAxoMessageProperties VAR_INPUT /// /// Arbitrary message string. @@ -219,7 +219,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// Use this category when you want to report to the user an information about a possible problem, that may adversly affect a process. /// Information in this cateogory aims to help the user to identify a problem, the cause of such problem does not necessarily stops the process. /// - METHOD PUBLIC Warning : IAxoMessageProperties + METHOD PUBLIC Warning : AXOpen.Messaging.Dynamic.IAxoMessageProperties VAR_INPUT /// /// Arbitrary message string. @@ -549,7 +549,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// /// Pinned messages do no accept incomming messages on the same messenger. The incomming messages will be though the context logger when active. /// - METHOD PUBLIC Pin: IAxoMessageProperties + METHOD PUBLIC Pin: AXOpen.Messaging.Dynamic.IAxoMessageProperties IF NOT(_Parent = NULL) THEN IF NOT(_Parent.GetContext()= NULL) THEN IF(_pinnable) THEN @@ -582,7 +582,7 @@ NAMESPACE AXOpen.Messaging.Dynamic /// /// Creates message of given category for this messenger. /// - METHOD PUBLIC Post : IAxoMessageProperties + METHOD PUBLIC Post : AXOpen.Messaging.Dynamic.IAxoMessageProperties VAR_INPUT /// /// Arbitrary message string. diff --git a/src/messaging/ctrl/src/Static/AxoMessenger.st b/src/messaging/ctrl/src/Static/AxoMessenger.st index 31e7f0ee0..de3040f3a 100644 --- a/src/messaging/ctrl/src/Static/AxoMessenger.st +++ b/src/messaging/ctrl/src/Static/AxoMessenger.st @@ -3,7 +3,7 @@ USING AXOpen.Core; NAMESPACE AXOpen.Messaging.Static {#ix-prop: public string MessageText } {#ix-prop: public string Help } - CLASS AxoMessenger IMPLEMENTS IAxoMessageProperties + CLASS AxoMessenger IMPLEMENTS AXOpen.Messaging.Static.IAxoMessageProperties VAR PUBLIC {#ix-attr:[ReadOnly()]} IsActive : BOOL; @@ -65,7 +65,7 @@ NAMESPACE AXOpen.Messaging.Static THIS.Serve(_object.GetContext()); END_METHOD - METHOD PUBLIC Activate : IAxoMessageProperties + METHOD PUBLIC Activate : AXOpen.Messaging.Static.IAxoMessageProperties VAR_INPUT _category : eAxoMessageCategory; END_VAR @@ -94,7 +94,7 @@ NAMESPACE AXOpen.Messaging.Static Activate := THIS; END_METHOD - METHOD PUBLIC ActivateOnCondition : IAxoMessageProperties + METHOD PUBLIC ActivateOnCondition : AXOpen.Messaging.Static.IAxoMessageProperties VAR_INPUT _condition : BOOL; _category : eAxoMessageCategory; @@ -144,12 +144,12 @@ NAMESPACE AXOpen.Messaging.Static END_IF; END_METHOD - METHOD PUBLIC RequireAcknowledgement : IAxoMessageProperties + METHOD PUBLIC RequireAcknowledgement : AXOpen.Messaging.Static.IAxoMessageProperties AcknowledgementRequired := TRUE; RequireAcknowledgement := THIS; END_METHOD - METHOD PUBLIC DoNotRequireAcknowledgement : IAxoMessageProperties + METHOD PUBLIC DoNotRequireAcknowledgement : AXOpen.Messaging.Static.IAxoMessageProperties AcknowledgementRequired := FALSE; DoNotRequireAcknowledgement := THIS; END_METHOD diff --git a/src/probers/ctrl/apax.yml b/src/probers/ctrl/apax.yml index d0b1fa6b9..98ba58656 100644 --- a/src/probers/ctrl/apax.yml +++ b/src/probers/ctrl/apax.yml @@ -1,5 +1,5 @@ name: "@ix-ax/axopen.probers" -version : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' +version : '0.1.4-83-Add-documentation-for-AxoMessenger.65' type: lib targets: # - "1500" @@ -8,7 +8,7 @@ targets: files: - src dependencies: - "@ix-ax/axopen.core" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' + "@ix-ax/axopen.core" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' "@ax/axunit-library": ^4.0.6 devDependencies: "@ax/sdk": 3.0.8 diff --git a/src/simatic1500/ctrl/apax-lock.json b/src/simatic1500/ctrl/apax-lock.json index 750772426..29b5fabd2 100644 --- a/src/simatic1500/ctrl/apax-lock.json +++ b/src/simatic1500/ctrl/apax-lock.json @@ -24,9 +24,9 @@ "integrity": "sha512-rMK4IdvXJUWISQswNIYJ95HUWhlvEl8D1x9t/bSJB0olEAei0yb95F1I0lJoOuYu1gFCH3S/8eiAwCvlW7MrTA==" }, "@ax/axunit-library": { - "version": "3.0.6", - "resolved": "https://registry.simatic-ax.siemens.io/@ax/axunit-library/-/axunit-library-3.0.6.tgz", - "integrity": "sha512-DlO8pb1gN7UGPPp3s7dUod0V3er+GHcUMQNVwVYwFsjo6kfhzCYtup2hh2EUPIETgo6svJv6bg5ADC85YlpAQA==" + "version": "4.0.6", + "resolved": "https://registry.simatic-ax.siemens.io/@ax/axunit-library/-/axunit-library-4.0.6.tgz", + "integrity": "sha512-sgg1SNngQ9lTP/v8e+AyZq6hCf+563P3S4xep6uCdHIZMmW9GYkvKTjh56+ZKQMpGFrcr9Sn0Aw6dE7mbINwXg==" }, "@ax/axunit-llvm-runner-gen": { "version": "3.0.6", diff --git a/src/simatic1500/ctrl/apax.yml b/src/simatic1500/ctrl/apax.yml index 60bfac45d..59cb92485 100644 --- a/src/simatic1500/ctrl/apax.yml +++ b/src/simatic1500/ctrl/apax.yml @@ -1,5 +1,5 @@ name: "@ix-ax/axopen.simatic1500" -version : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' +version : '0.1.4-83-Add-documentation-for-AxoMessenger.65' type: lib targets: # - "1500" @@ -9,7 +9,7 @@ files: - src dependencies: "@ax/simatic-1500": 3.0.2 - "@ix-ax/axopen.abstractions" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' + "@ix-ax/axopen.abstractions" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' "@ax/axunit-library": ^4.0.6 devDependencies: "@ax/sdk": 3.0.18 diff --git a/src/templates.simple/ctrl/apax.yml b/src/templates.simple/ctrl/apax.yml index 216d25c13..c653f0a97 100644 --- a/src/templates.simple/ctrl/apax.yml +++ b/src/templates.simple/ctrl/apax.yml @@ -1,5 +1,5 @@ name: "axosimple" -version : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' +version : '0.1.4-83-Add-documentation-for-AxoMessenger.65' type: app registries: '@ix-ax': https://npm.pkg.github.com/ @@ -12,10 +12,10 @@ devDependencies: "@ax/sdk": 3.0.18 "@ax/sld": ^0.14.2 dependencies: - "@ix-ax/axopen.core" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' - "@ix-ax/axopen.data" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' - "@ix-ax/axopen.messaging" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' - "@ix-ax/axopen.simatic1500" : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' + "@ix-ax/axopen.core" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' + "@ix-ax/axopen.data" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' + "@ix-ax/axopen.messaging" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' + "@ix-ax/axopen.simatic1500" : '0.1.4-83-Add-documentation-for-AxoMessenger.65' "@ax/axunit-library" : ^4.0.6 variables: diff --git a/src/utils/ctrl/apax.yml b/src/utils/ctrl/apax.yml index 8c3d9148e..f53955242 100644 --- a/src/utils/ctrl/apax.yml +++ b/src/utils/ctrl/apax.yml @@ -1,5 +1,5 @@ name: "@ix-ax/axopen.utils" -version : '0.1.4-55-Create-unit-tests-for-messaging-tranfered-from-tco.72' +version : '0.1.4-83-Add-documentation-for-AxoMessenger.65' type: lib targets: # - "1500"