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
DynamicTraceLoader (FB) ¶ FUNCTION_BLOCK DynamicTraceLoader This function block is used to load a trace from a file. Properties: UnknownVariable Methods: Initialize LoadFromFile Structure: Initialize (Method) LoadFromFile (Method) UnknownVariable (Property)
DynamicTraceLoader.Initialize (METH) ¶ METHOD Initialize Method Initialize Initialize must be called before a call to method LoadFromFile can be executed. InOut: Scope Name Type Comment Input psApplication POINTER TO STRING Points to the name of the application, where the trace runs pArrRecordConfiguration POINTER TO ARRAY [0..0] OF TraceRecordConfiguration Points to an array, that will be used to store the record configuration temporarily iMaxRecordCount INT Contains the maximum number of records, that can be stored in the array pArrRecordConfiguration
DynamicTraceLoader.LoadFromFile (METH) ¶ METHOD LoadFromFile : RTS_IEC_RESULT Load a trace from a file. Before this method can be called the method Initialize has to be called. Return codes: ERR_ENTRIES_REMAINING if an additional call to this method is required in order to process the loading. (only in the datasource case) ERR_NOT_SUPPORTED if the CmpTraceMgr library is too old. ERR_DS_INVALID_PATH if at least one variable of the trace packet configuration is unknown (also for the non-datasource case, i.e. the local case) ERR_OUT_OF_LIMITS if the array passed to the Initialize* method is not large enough to hold all the records from the file InOut: Scope Name Type Comment Return LoadFromFile RTS_IEC_RESULT Input psFilename POINTER TO STRING Points to the name of the file to load
Assert_ArrayOfString_Equal (FUN) ¶ FUNCTION Assert_ArrayOfString_Equal : BOOL Assertion function to check that two ARRAY OF STRING are equal. Two arrays are equal if all of the following conditions are met: * the two array have the same bounds * for each index the values of both arrays are equal InOut: Scope Name Type Initial Comment Return Assert_ArrayOfString_Equal BOOL TRUE if the assertion passes succesfully, FALSE otherwise Input context IBaseIecUnitTest The instance of the test function block calling this function. This instance can be provided by using THIS^ . referenceArray POINTER TO STRING The reference array to check actualArray POINTER TO STRING The array to check wsErrorMsg WSTRING(Constants.WSTRING_LENGTH) “” A custom error message, that is added to the error message of the assertion itself. If this parameter is used, it is recommended to adapt the value of the library parameter Constants.WSTRING_LENGTH .