WordAssertions

Short summary

This class provides assert statements for words

Access	Abstract	Final	Extends	Implements
INTERNAL	No	No	AbstractAssertion	IWordAssertions

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