Skip to main content

UxintAssertions

Short summary

This class provides assert statements for unsigned register length integers (__UXINT)

AccessAbstractFinalExtendsImplements
INTERNALNoNoAbstractAssertionIUxintAssertions

UML Diagram

Parameters

none

Properties

className

Type: CNM_AbstractObject.ClassName

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

Methods

valueIsEqualTo

  • Parameters:
    • currentValue (__UXINT): current value to check
    • expectedValue (__UXINT): expected value to compare
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current value is equal to the expected value

valueIsEven

  • Parameters:
    • currentValue (__UXINT): current value to check
    • message (Tc2_System.T_MaxString): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current value is even

valueIsGreaterThan

  • Parameters:
    • currentValue (__UXINT): current value to check
    • lessValue (__UXINT): less than lower limit
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current value is greater than the less value

valueIsInRangeOf

  • Parameters:
    • lowerLimit (__UXINT): lower limit for the current value
    • currentValue (__UXINT): current value to check
    • upperLimit (__UXINT): upper limit for the current value
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current value is inside a limit

valueIsLessThan

  • Parameters:
    • currentValue (__UXINT): current value to check
    • greaterValue (__UXINT): greater than upper limit
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current value is less than the greater value

valueIsMax

  • Parameters:
    • currentValue (__UXINT): current value to check
    • maximumValue (__UXINT): upper limit for the current value
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current value is less than or equal to the maximum value

valueIsMin

  • Parameters:
    • currentValue (__UXINT): current value to check
    • minimumValue (__UXINT): lower limit for the current value
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current value is greater than or equal to the minimum value

valueIsNotEqualTo

  • Parameters:
    • currentValue (__UXINT): current value to check
    • unexpectedValue (__UXINT): unexpected value to compare
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current value is not equal to the unexpected value

valueIsOdd

  • Parameters:
    • currentValue (__UXINT): current value to check
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the current value is odd

Code

Declaration

{attribute 'reflection'}
FUNCTION_BLOCK INTERNAL UxintAssertions EXTENDS AbstractAssertion IMPLEMENTS IUxintAssertions
VAR
END_VAR
VAR CONSTANT
LSB_MASK :__UXINT := 1;
END_VAR