Functions ¶ AssignBool (Function) BoolCompareToPWS (Function) CreateAssertionErrorMessageForArrayContent (Function) CreateAssertionErrorMessageForInterface (Function) CreateAssertionErrorMessageForStandardDatatype (Function) CreateAssertionErrorMessageForStandardDatatypeSingleValue (Function) CreateAssertionErrorMessageNonEqualArrayBounds (Function)
AssignBool (FUN) ¶ FUNCTION AssignBool : BOOL The function helps to set a boolean variable by using the enumaration BOOLASSIGN InOut: Scope Name Type Return AssignBool BOOL Input pValue POINTER TO BOOL eAssign BOOLASSIGN
BoolCompareToPWS (FUN) ¶ FUNCTION BoolCompareToPWS : POINTER TO WSTRING InOut: Scope Name Type Return BoolCompareToPWS POINTER TO WSTRING Input eCompareValue BOOLCOMPARE
CreateAssertionErrorMessageForArrayContent (FUN) ¶ FUNCTION CreateAssertionErrorMessageForArrayContent Helper function to create an error message for assertions that failed because of the content of an array. Hint: for longer arrays or if wsErrorMsg is used, it is recommended to change the value of the library parameter Constants.WSTRING_LENGTH . InOut: Scope Name Type Comment Inout wsAssertError WSTRING(Constants.WSTRING_LENGTH) Inout Const wsAssertOperator WSTRING(Constants.WSTRING_LENGTH) The assert operator e.g. Strings.EQUAL or “CONTAINS SEQUENCE” wsErrorMsg WSTRING(Constants.WSTRING_LENGTH) A custom error message that should be appended. If no message is provided the “Additional information” part will not be added to the returned error. wsActualValues WSTRING(Constants.WSTRING_LENGTH) The values of the actual array as WSTRING wsReferenceValues WSTRING(Constants.WSTRING_LENGTH) The values of the actual array as WSTRING
CreateAssertionErrorMessageForInterface (FUN) ¶ FUNCTION CreateAssertionErrorMessageForInterface Helper function to create an error message for failed assertions of standard datatypes. Hint: if wsErrorMsg is used, it is recommended to change the value of the library parameter Constants.WSTRING_LENGTH . InOut: Scope Name Type Comment Inout wsAssertError WSTRING(Constants.WSTRING_LENGTH) Inout Const wsAssertOperator WSTRING(Constants.WSTRING_LENGTH) The assert operator e.g. Strings.EQUAL or Strings.CONTAINS wsErrorMsg WSTRING(Constants.WSTRING_LENGTH) A custom error message that should be appended. If no message is provided the “Additional information” part will not be added to the returned error.
Assert_ArrayOfReal_ContainsAllOf (FUN) ¶ FUNCTION Assert_ArrayOfReal_ContainsAllOf : BOOL Assertion function to check that an ARRAY OF REAL 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_ArrayOfReal_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 REAL An array with all values that should be contained. actualArray POINTER TO REAL The array to check precision REAL 0.0 A value to specify an allowed deviation. Default is 0.0 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_ArrayOfReal_ContainsNoneOf (FUN) ¶ FUNCTION Assert_ArrayOfReal_ContainsNoneOf : BOOL Assertion function to check that an ARRAY OF REAL contains none of the specified values. InOut: Scope Name Type Initial Comment Return Assert_ArrayOfReal_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 REAL An array with all values that should not be contained. actualArray POINTER TO REAL The array to check precision REAL 0.0 A value to specify an allowed deviation. Default is 0.0 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_ArrayOfReal_ContainsNot (FUN) ¶ FUNCTION Assert_ArrayOfReal_ContainsNot : BOOL Assertion function to check that an ARRAY OF REAL does not contain a specific value InOut: Scope Name Type Initial Comment Return Assert_ArrayOfReal_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 REAL The value that should not be contained actualArray POINTER TO REAL The array to check precision REAL 0.0 A value to specify an allowed deviation. Default is 0.0 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_ArrayOfReal_ContainsOneOf (FUN) ¶ FUNCTION Assert_ArrayOfReal_ContainsOneOf : BOOL Assertion function to check that an ARRAY OF REAL contains at least one of the specified values. InOut: Scope Name Type Initial Comment Return Assert_ArrayOfReal_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 REAL An array with values that should be contained. actualArray POINTER TO REAL The array to check precision REAL 0.0 A value to specify an allowed deviation. Default is 0.0 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_ArrayOfReal_ContainsSequence (FUN) ¶ FUNCTION Assert_ArrayOfReal_ContainsSequence : BOOL Assertion function to check that an ARRAY OF REAL contains a specific sequence of values InOut: Scope Name Type Initial Comment Return Assert_ArrayOfReal_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 REAL The array with the sequence that should be contained actualArray POINTER TO REAL The array to check precision LREAL 0.0 A value to specify an allowed deviation. Default is 0.0 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 .