Skip to main content

LWordAssertions

Short summary

This class provides assert statements for long words

AccessAbstractFinalExtendsImplements
INTERNALNoNoAbstractAssertionILWordAssertions

UML Diagram

Parameters

none

Properties

className

Type: CNM_AbstractObject.ClassName

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

Methods

andMaskIsEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • mask (LWORD): 2nd operand for bitwise operation
    • expectedValue (LWORD): expected result after masking
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the result current value bitwise AND mask is equal to the expected value

andMaskIsNotEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • mask (LWORD): 2nd operand for bitwise operation
    • unexpectedValue (LWORD): unexpected result after masking
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the result current value bitwise AND mask

bitXIsEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • number (BitNumberLWord): number of bit to check
    • expectedValue (BOOL): expected value of bit
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the selected bit of current value

bitXIsNotEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • number (BitNumberLWord): number of bit to check
    • unexpectedValue (BOOL): unexpected value of bit
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the selected bit of current value

bitXIsSet

  • Parameters:
    • currentValue (LWORD): current value to check
    • number (BitNumberLWord): number of bit to check
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the selected bit of current value

bitXIsUnset

  • Parameters:
    • currentValue (LWORD): current value to check
    • number (BitNumberLWord): number of bit to check
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the selected bit of current value

lsbIsEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • expectedValue (BOOL): expected value of lsb
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the least significant bit of current value

lsbIsNotEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • unexpectedValue (BOOL): unexpected value of lsb
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the least significant bit of current value

lsbIsSet

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

This assertion method checks if the least significant bit of current value

lsbIsUnset

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

This assertion method checks if the least significant bit of current value

msbIsEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • expectedValue (BOOL): expected value of msb
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the most significant bit of current value

msbIsNotEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • unexpectedValue (BOOL): unexpected value of msb
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the most significant bit of current value

msbIsSet

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

This assertion method checks if the most significant bit of current value

msbIsUnset

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

This assertion method checks if the most significant bit of current value

orMaskIsEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • mask (LWORD): 2nd operand for bitwise operation
    • expectedValue (LWORD): expected result after masking
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the result current value bitwise OR mask is equal to the expected value

orMaskIsNotEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • mask (LWORD): 2nd operand for bitwise operation
    • unexpectedValue (LWORD): unexpected result after masking
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the result current value bitwise OR mask

valueIsEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • expectedValue (LWORD): 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

valueIsGreaterThan

  • Parameters:
    • currentValue (LWORD): current value to check
    • lessValue (LWORD): 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 (LWORD): lower limit for the current value
    • currentValue (LWORD): current value to check
    • upperLimit (LWORD): 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 (LWORD): current value to check
    • greaterValue (LWORD): 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 (LWORD): current value to check
    • maximumValue (LWORD): 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 (LWORD): current value to check
    • minimumValue (LWORD): 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 (LWORD): current value to check
    • unexpectedValue (LWORD): 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

xorMaskIsEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • mask (LWORD): 2nd operand for bitwise operation
    • expectedValue (LWORD): expected result after masking
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the result current value bitwise XOR mask is equal to the expected value

xorMaskIsNotEqualTo

  • Parameters:
    • currentValue (LWORD): current value to check
    • mask (LWORD): 2nd operand for bitwise operation
    • unexpectedValue (LWORD): unexpected result after masking
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if the result current value bitwise XOR mask

Code

Declaration

{attribute 'reflection'}
FUNCTION_BLOCK INTERNAL LWordAssertions EXTENDS AbstractAssertion IMPLEMENTS ILWordAssertions
VAR
END_VAR
VAR CONSTANT
(* least significant bit *)
LSB :LWORD := 16#0000_0000_0000_0001;
(* most significant bit *)
MSB :LWORD := 16#8000_0000_0000_0000;
END_VAR