Skip to main content

DWordAssertions

Short summary

This class provides assert statements for double words

AccessAbstractFinalExtendsImplements
INTERNALNoNoAbstractAssertionIDWordAssertions

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 (DWORD): current value to check
    • mask (DWORD): 2nd operand for bitwise operation
    • expectedValue (DWORD): 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 (DWORD): current value to check
    • mask (DWORD): 2nd operand for bitwise operation
    • unexpectedValue (DWORD): 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 (DWORD): current value to check
    • number (BitNumberDWord): 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 (DWORD): current value to check
    • number (BitNumberDWord): 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 (DWORD): current value to check
    • number (BitNumberDWord): 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 (DWORD): current value to check
    • number (BitNumberDWord): 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 (DWORD): 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 (DWORD): 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 (DWORD): 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 (DWORD): 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 (DWORD): 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 (DWORD): 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 (DWORD): 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 (DWORD): 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 (DWORD): current value to check
    • mask (DWORD): 2nd operand for bitwise operation
    • expectedValue (DWORD): 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 (DWORD): current value to check
    • mask (DWORD): 2nd operand for bitwise operation
    • unexpectedValue (DWORD): 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 (DWORD): current value to check
    • expectedValue (DWORD): 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 (DWORD): current value to check
    • lessValue (DWORD): 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 (DWORD): lower limit for the current value
    • currentValue (DWORD): current value to check
    • upperLimit (DWORD): 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 (DWORD): current value to check
    • greaterValue (DWORD): 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 (DWORD): current value to check
    • maximumValue (DWORD): 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 (DWORD): current value to check
    • minimumValue (DWORD): 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 (DWORD): current value to check
    • unexpectedValue (DWORD): 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 (DWORD): current value to check
    • mask (DWORD): 2nd operand for bitwise operation
    • expectedValue (DWORD): 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 (DWORD): current value to check
    • mask (DWORD): 2nd operand for bitwise operation
    • unexpectedValue (DWORD): 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 DWordAssertions EXTENDS AbstractAssertion IMPLEMENTS IDWordAssertions
VAR
END_VAR
VAR CONSTANT
(* least significant bit *)
LSB :DWORD := 16#0000_0001;
(* most significant bit *)
MSB :DWORD := 16#8000_0000;
END_VAR