FAILUREMODE (ENUM) ¶ TYPE FAILUREMODE : This enum defines the possible failure modes in a test manager check. This enum is synchronized to to the .NET FailureMode enum, so all changes here need to be replicated there. Attributes: qualified_only InOut: Name Initial Comment Warning 1 The problem is only reported as a warning in the test report, but execution continues normally. We intentionally start the enum values with 1 to catch uninitialized variables. AbortTestCase The current test case is aborted (and directly following tests of TestCaseType.Consecutive are skipped). This is the default when no mode is explicitly defined nor inherited. AbortUnitTesting The whole IEC Unit Test element is aborted when this failure occurs. AbortTestRun The whole test script run is aborted when this failure occurs.
Function Blocks ¶ BaseMultiTest (FunctionBlock) HandleAssertResult (Method) HasError (Method) SetErrorVars (Method) prvAbort (Method) prvDone (Method) prvError (Method) prvResetOutputs (Method) PrintfOne (FunctionBlock) FB_Init (Method) Print (Method) SetText (Method) Text (Property) Testcase (FunctionBlock) Execute (Method) HandleAssertResult (Method) HasError (Method)
BaseMultiTest.HandleAssertResult (METH) ¶ METHOD HandleAssertResult : BOOL InOut: Scope Name Type Return HandleAssertResult BOOL Input eAssertion_Result ASSERTION_RESULT wsErrorMsg WSTRING(Constants.WSTRING_LENGTH)
BaseMultiTest (FB) ¶ FUNCTION_BLOCK PUBLIC BaseMultiTest EXTENDS CBM.ETrigA IMPLEMENTS IBaseIecUnitTest This FB is the base for the multi-test POUs and contains the additional inputs and outputs. InOut: Scope Name Type Comment Inherited from Input xExecute BOOL Rising edge: Action starts Falling edge: Resets outputs If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values ( xDone , xError , iError ) are present at the outputs for exactly one cycle. ETrigA xAbort BOOL TRUE : Action is stopped immediately and all outputs are reset to their initial values. ETrigA Output xDone BOOL TRUE : Action successfully completed ETrigA xBusy BOOL TRUE : Function block active ETrigA xError BOOL TRUE : Error occurred, function block aborts action FALSE : No error ETrigA xAborted BOOL TRUE : Action aborted by user ETrigA Input diTestCaseIndex DINT Index of the test case which will be executed. In combination with xGetTestInfo = TRUE you can fetch the following information about the multi-test POU: name of the test case categories time-out for the test case If the test case index is -1 then you get the count of test cases in the multi-test POU. xGetTestInfo BOOL If set to TRUE the outputs return the basic information about the test case. Output diTestCaseCount DINT If xGetTestInfo = TRUE and diTestCaseIndex = -1 then you get the count of test cases in the multi-test POU. wsTestCaseName WSTRING(Constants.WSTRING_LENGTH) Name of the current test case wsTestCaseCategories WSTRING(Constants.WSTRING_LENGTH) Test categories diTestCaseTimeout DINT Timeout of the test case. In milliseconds. wsInfo WSTRING(Constants.WSTRING_LENGTH) Info about the test case. It can contain the description of the test step if used by a test table with the necessary column. eError UT_ERROR Error ID wsError WSTRING(Constants.WSTRING_LENGTH) Error message wsWarning WSTRING(Constants.WSTRING_LENGTH) Warning message eFailureMode FAILUREMODE Failure mode informs how to proceed after the test case failed. Methods: HandleAssertResult HasError SetErrorVars prvAbort prvDone prvError prvResetOutputs Structure: HandleAssertResult (Method) HasError (Method) SetErrorVars (Method) prvAbort (Method) prvDone (Method) prvError (Method) prvResetOutputs (Method)
BaseMultiTest.HasError (METH) ¶ METHOD HasError : BOOL InOut: Scope Name Type Return HasError BOOL
Strings (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Constant LEFT WSTRING “’ “ RIGHT WSTRING “ ‘” LEFT_DOT WSTRING “’.” DOT WSTRING “.” KOMMA_LEFT WSTRING “, “ TUPLE_END WSTRING “): ‘” ASSERTION_FAILED WSTRING “Assertion failed: ‘” ASSERTION_FAILED_VALUE_INDEX WSTRING “Assertion failed for value at index (” ASSERTION_FAILED_VALUE_MISMATCH_CONDITION WSTRING “Assertion failed: The given value(s) is/are not matching the condition ‘” ADDITIONAL_INFORMATION WSTRING “ Additional information: “ UNEQUAL WSTRING “<>” EQUAL WSTRING “=” GREATER_THEN WSTRING “>” LESS_THEN WSTRING “<” GREATER_EQUAL WSTRING “>=” LESS_EQUAL WSTRING “<=” CONTAINS WSTRING “CONTAINS” CONTAINS_NOT WSTRING “CONTAINS NOT” IS_FALSE WSTRING “IS FALSE” IS_TRUE WSTRING “IS TRUE” ENDS_WITH WSTRING “ENDS WITH” STARTS_WITH WSTRING “STARTS WITH” LOWER WSTRING “Lower” UPPER WSTRING “Upper”
Trace Mgr Utils Library Documentation ¶ Company : Intern Title : Trace Mgr Utils Version : 4.5.0.0 Categories : Intern|Visu Namespace : TraceMgr_Utils Author : CODESYS Development GmbH Placeholder : TraceMgrUtils Description [ 1 ] ¶ This library contains utility functions related to the trace manager. Contents: ¶ Access to data source RemotePlcRequestIdentification (Enum) Services (GVL) DynamicTraceLoader (FunctionBlock) Initialize (Method) LoadFromFile (Method) UnknownVariable (Property) DynamicTraceLoaderRemote (FunctionBlock) ArrayTooSmall (Property) InitializeRemote (Method) LoadFromFile (Method) State (Property) UnknownVariable (Property) Function blocks Collections Logging VisuFbRecordConditionInfo (FunctionBlock) Functions TraceFctGetPropertyValue (Function) Globals TraceMgrUtilConstants (GVL) TraceMgrUtilGlobals (GVL) IAddressResolver (Interface) Resolve (Method) Indices and tables ¶ [ 1 ] Based on Trace Mgr Utils.library, last modified 13.12.2023, 11:05:12. LibDoc 4.4.0.0-b.37 The content file Trace Mgr Utils.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 13.12.2023, 11:05:14.
Access to data source ¶ RemotePlcRequestIdentification (Enum) Services (GVL)
RemotePlcRequestIdentification (ENUM) ¶ TYPE RemotePlcRequestIdentification : This enumeration is used to identify the requests to send to the PLC Attributes: qualified_only InOut: Name None
Services (GVL) ¶ Attributes: qualified_only InOut: Scope Name Type Initial Comment Constant SG_TraceManager UINT 16#F Service Groups SG_TrendStorage UINT 16#1E SRV_TrendGetMinMaxTimestamps UINT 16#83 Trend storage services SRV_TrendReadTrendData UINT 16#84 TAG_TrendApplicationName UINT 16#1 Tags for the requests TAG_TrendPacketName UINT 16#2 TAG_TrendTimestamps UINT 16#3 TAG_TrendVariables UINT 16#4 TAG_TrendError UINT 16#1 Tags for the responses TAG_TrendGetMinMaxTimestamps UINT 16#2 TAG_TrendCountVariables UINT 16#3 TAG_TrendReadTrendDataVariables UINT 16#85 TAG_TrendRelevantVariables UINT 16#86 SUBT_TrendReadTrendDataVariable UINT 16#5 TAG_TrendReadTrendDataTimestamps UINT 16#6 TAG_TrendReadTrendDataData UINT 16#7 SUBT_TrendRelevantVariable UINT 16#8 TAG_TrendReadTrendDataValidity UINT 16#9 TAG_TrendReadTrendDataPacket UINT 16#A SUBT_TrendVariableDescription UINT 16#9 SUBT_TrendAttachedYAxis UINT 16#A SUBT_TrendLineProperties UINT 16#B SUBT_TrendAreaProperties UINT 16#C SRV_TrcPacketCreate UINT 16#2 Trace manager services SRV_TrcPacketDelete UINT 16#3 SRV_TrcPacketComplete UINT 16#4 SRV_TrcPacketOpen UINT 16#5 SRV_TrcPacketClose UINT 16#6 SRV_TrcPacketGetConfig UINT 16#9 SRV_TrcRecordAdd UINT 16#D SRV_TrcPacketStart UINT 16#A SRV_TrcPacketStop UINT 16#B SRV_TrcPacketRead UINT 16#7 SRV_TrcPacketResetTrigger UINT 16#10 SRV_TrcPacketStore UINT 16#11 SRV_TrcPacketRestore UINT 16#12 SRV_TrcGetConfigFromFile UINT 16#13 TAG_TrcPacketName UINT 16#10 Tags for the requests TAG_TrcPacketComment UINT 16#16 TAG_TrcAppName UINT 16#11 TAG_TrcTaskName UINT 16#12 TAG_TrcEveryNCycles UINT 16#13 TAG_TrcBufferEntries UINT 16#14 TAG_TrcPacketFlags UINT 16#15 TAG_TrcTrigger UINT 16#86 TAG_TrcTriggerLevel UINT 16#30 TAG_TrcTriggerEdge UINT 16#31 TAG_TrcTriggerUpdatesAfterTrigger UINT 16#34 TAG_TrcTriggerFlags UINT 16#33 TAG_TrcVariable UINT 16#83 TAG_TrcVariableAddressFlag UINT 16#21 TAG_TrcVariableAddressArea UINT 16#23 TAG_TrcVariableAddressOffset UINT 16#24 TAG_TrcVariableName UINT 16#20 TAG_TrcVariableTypeClass UINT 16#25 TAG_TrcVariableSize UINT 16#26 TAG_TrcPacketHandle UINT 16#40 TAG_TrcError UINT 16#FF7F TAG_TrcGraphType UINT 16#27 TAG_TrcGraphColor UINT 16#28 TAG_TrcParameterId UINT 16#29 TAG_TrcParameterModuleType UINT 16#30 TAG_TrcParameterInstance UINT 16#31 TAG_TrcActivateMinWarning UINT 16#32 TAG_TrcCriticalLowerLimit UINT 16#33 TAG_TrcMinWarningColor UINT 16#34 TAG_TrcActivateMaxWarning UINT 16#35 TAG_TrcCriticalUpperLimit UINT 16#36 TAG_TrcMaxWarningColor UINT 16#37 TAG_TrcSecondYAxis UINT 16#38 TAG_TrcRecordHandle UINT 16#41 TAG_TrcRecordConfiguration UINT 16#84 TAG_TrcPacketTimestamp UINT 16#4A TAG_TrcTraceStateStruct UINT 16#87 TAG_TrcTraceState UINT 16#50 TAG_TrcTraceStartTime UINT 16#51 TAG_TrcTriggerState UINT 16#52 TAG_TrcTriggerTimestamp UINT 16#53 TAG_TrcTraceChangeTime UINT 16#55 TAG_TrcRecordBuffer UINT 16#42 TAG_TrcRecordResult UINT 16#47 TAG_TrcCondition UINT 16#85 TAG_TrcFileName UINT 16#4C