Skip to main content

Utf8StringPointerAssertions

Short summary​

This class provides assert statements for UTF-8 strings

Attention: All strings are handled as null-terminated byte streams.

AccessAbstractFinalExtendsImplements
INTERNALNoNoAbstractStringPointerAssertionsIUtf8StringPointerAssertions

UML Diagram​

Properties​

className​

Type: CNM_AbstractObject.ClassName

This abstract property returns the class name of the concrete object, …

Methods​

contains​

  • Parameters:
    • stringToCheck (POINTER TO BYTE): current string to check
    • searchString (POINTER TO BYTE): string must be found in stringToCheck
    • ignoreCases (BOOL): TRUE means ignore cases; FALSE means that cases must be equal too
    • message (AssertMessage): message if the assertion is false
    • normalizeStrings (BOOL): normalize both strings for check
  • Return type: VOID

This assertion method checks if the current string stringToCheck contains the search string searchString.…

containsNo​

  • Parameters:
    • stringToCheck (POINTER TO BYTE): current string to check
    • searchString (POINTER TO BYTE): string must be found in stringToCheck
    • ignoreCases (BOOL): TRUE means ignore cases; FALSE means that cases must be equal too
    • message (AssertMessage): message if the assertion is false
    • normalizeStrings (BOOL): normalize both strings for check
  • Return type: VOID

This assertion method checks if the current string stringToCheck doesn't contain the search string searchString.…

endsWith​

  • Parameters:
    • stringToCheck (POINTER TO BYTE): current string to check
    • end (POINTER TO BYTE): string must be the end of stringToCheck
    • ignoreCases (BOOL): TRUE means ignore cases; FALSE means that cases must be equal too
    • trim (BOOL): TRUE means truncation of spaces on the right side of stringToCheck
    • message (AssertMessage): message if the assertion is false
    • normalizeStrings (BOOL): normalize both strings for check
  • Return type: VOID

This assertion method checks if the current string stringToCheck ends with the string end.…

isEqualTo​

  • Parameters:
    • stringToCheck (POINTER TO BYTE): current string to check
    • expected (POINTER TO BYTE): stringToCheck must be equal to expected
    • ignoreCases (BOOL): TRUE means ignore cases; FALSE means that cases must be equal too
    • message (AssertMessage): message if the assertion is false
    • normalizeStrings (BOOL): normalize both strings for check
  • Return type: VOID

This assertion method checks if the current string stringToCheck is equal to expected.…

isNotEqualTo​

  • Parameters:
    • stringToCheck (POINTER TO BYTE): current string to check
    • unexpected (POINTER TO BYTE): stringToCheck must be not equal to expected
    • ignoreCases (BOOL): TRUE means ignore cases; FALSE means that cases must be equal too
    • message (AssertMessage): message if the assertion is false
    • normalizeStrings (BOOL): normalize both strings for check
  • Return type: VOID

This assertion method checks if the current string stringToCheck is not equal to unexpected.…

lengthIsBetween​

  • Parameters:
    • stringToCheck (POINTER TO BYTE): current string to check
    • minLength (UDINT): lower limit of the string length
    • maxLength (UDINT): upper limit of the string length
    • stringLengthUnit (UnicodeStringLengthUnit): string length units of measurement
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current string stringToCheck length is between minLength and maxLength.…

lengthIsExact​

  • Parameters:
    • stringToCheck (POINTER TO BYTE): current string to check
    • expectedLength (UDINT): expected length of stringToCheck
    • stringLengthUnit (UnicodeStringLengthUnit): string length units of measurement
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current string stringToCheck length is equal to expectedLength.…

lengthIsMax​

  • Parameters:
    • stringToCheck (POINTER TO BYTE): current string to check
    • maxLength (UDINT): upper limit of the length of stringToCheck
    • stringLengthUnit (UnicodeStringLengthUnit): string length units of measurement
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current string stringToCheck length is equal or less than to maxLength.…

lengthIsMin​

  • Parameters:
    • stringToCheck (POINTER TO BYTE): current string to check
    • minLength (UDINT): lower limit of the length of stringToCheck
    • stringLengthUnit (UnicodeStringLengthUnit): string length units of measurement
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current string stringToCheck length is equal or grater than to minLength.…

startsWith​

  • Parameters:
    • stringToCheck (POINTER TO BYTE): current string to check
    • start (POINTER TO BYTE): expected start of stringToCheck
    • ignoreCases (BOOL): TRUE means ignore cases; FALSE means that cases must be equal too
    • trim (BOOL): TRUE means truncation of spaces on the left side of stringToCheck
    • message (AssertMessage): message if the assertion is false
    • normalizeStrings (BOOL): normalize both strings for check
  • Return type: VOID

This assertion method checks if the current string stringToCheck starts with string start.…

Code​

Declaration​

{attribute 'reflection'}
FUNCTION_BLOCK INTERNAL Utf8StringPointerAssertions EXTENDS AbstractStringPointerAssertions IMPLEMENTS IUtf8StringPointerAssertions