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 .
Assert_ArrayOfWString_ContainsAllOf (FUN) ¶ FUNCTION Assert_ArrayOfWString_ContainsAllOf : BOOL Assertion function to check that an ARRAY OF WSTRING contains all specified values. Important: only unique values are checked, the quantity of values is not considered. InOut: Scope Name Type Initial Comment Return Assert_ArrayOfWString_ContainsAllOf 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^ . referenceValues POINTER TO WSTRING An array with all values that should be contained. actualArray POINTER TO WSTRING 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 .
Assert_ArrayOfWString_Contains (FUN) ¶ FUNCTION Assert_ArrayOfWString_Contains : BOOL Assertion function to check that an ARRAY OF WSTRING contains a specific value InOut: Scope Name Type Initial Comment Return Assert_ArrayOfWString_Contains 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^ . referenceValue WSTRING The value that should be contained actualArray POINTER TO WSTRING 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 .
Assert_ArrayOfWString_ContainsNot (FUN) ¶ FUNCTION Assert_ArrayOfWString_ContainsNot : BOOL Assertion function to check that an ARRAY OF WSTRING does not contain a specific value InOut: Scope Name Type Initial Comment Return Assert_ArrayOfWString_ContainsNot 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^ . referenceValue WSTRING The value that should not be contained actualArray POINTER TO WSTRING 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 .
Assert_ArrayOfWString_ContainsNoneOf (FUN) ¶ FUNCTION Assert_ArrayOfWString_ContainsNoneOf : BOOL Assertion function to check that an ARRAY OF WSTRING contains none of the specified values. InOut: Scope Name Type Initial Comment Return Assert_ArrayOfWString_ContainsNoneOf 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^ . referenceValues POINTER TO WSTRING An array with all values that should not be contained. actualArray POINTER TO WSTRING 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 .
Assert_ArrayOfWString_ContainsOneOf (FUN) ¶ FUNCTION Assert_ArrayOfWString_ContainsOneOf : BOOL Assertion function to check that an ARRAY OF WSTRING contains at least one of the specified values. InOut: Scope Name Type Initial Comment Return Assert_ArrayOfWString_ContainsOneOf 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^ . referenceValues POINTER TO WSTRING An array with values that should be contained. actualArray POINTER TO WSTRING 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 .
Assert_ArrayOfWString_ContainsSequence (FUN) ¶ FUNCTION Assert_ArrayOfWString_ContainsSequence : BOOL Assertion function to check that an ARRAY OF WSTRING contains a specific sequence of values InOut: Scope Name Type Initial Comment Return Assert_ArrayOfWString_ContainsSequence 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 WSTRING The array with the sequence that should be contained actualArray POINTER TO WSTRING 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 .