Skip to main content

IPointerAssertions

Short summary

This interface provides assert statements for pointers

AccessAbstractFinalExtendsImplements
-NoNo__SYSTEM.IQueryInterface-

UML Diagram

Methods

isAligned

  • Parameters:
    • address (PVOID): memory address
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer is aligned with register size.

isDwordAligned

  • Parameters:
    • address (PVOID): memory address
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer is aligned with DWord size.

isEqualTo

  • Parameters:
    • address1 (PVOID): memory address
    • address2 (PVOID): memory address
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if address1 and address2 refer to the same address

isLwordAligned

  • Parameters:
    • address (PVOID): memory address
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer is aligned with Lword size.

isNotEqualTo

  • Parameters:
    • address1 (PVOID): memory address
    • address2 (PVOID): memory address
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if address1 and address2 refer not to the same address

isNotNull

  • Parameters:
    • address (PVOID): memory address
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer is not null

isNotOverlapping

  • Parameters:
    • address1 (PVOID): memory address
    • address2 (PVOID): memory address
    • sizeInBytes1 (UDINT): the size of the memory area identified by address1
    • sizeInBytes2 (UDINT): the size of the memory area identified by address2
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if memory areas are overlapping

isNull

  • Parameters:
    • address (PVOID): memory address
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer is null

isOverlapping

  • Parameters:
    • address1 (PVOID): memory address
    • address2 (PVOID): memory address
    • sizeInBytes1 (UDINT): the size of the memory area identified by address1
    • sizeInBytes2 (UDINT): the size of the memory area identified by address2
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if memory areas are overlapping

isValid

  • Parameters:
    • address (PVOID): memory address
    • sizeInBytes (UDINT): number of bytes
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer is valid.

isWordAligned

  • Parameters:
    • address (PVOID): memory address
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer is aligned with word size.

memoryAreaIsCnc

  • Parameters:
    • address (PVOID): memory address
    • sizeInBytes (UDINT): number of bytes
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer refers to cnc area

memoryAreaIsDynamic

  • Parameters:
    • address (PVOID): memory address
    • sizeInBytes (UDINT): number of bytes
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer refers to dynamic area

memoryAreaIsNotCnc

  • Parameters:
    • address (PVOID): memory address
    • sizeInBytes (UDINT): number of bytes
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer refers not to cnc area

memoryAreaIsNotDynamic

  • Parameters:
    • address (PVOID): memory address
    • sizeInBytes (UDINT): number of bytes
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer refers not to dynamic area

memoryAreaIsNotStatic

  • Parameters:
    • address (PVOID): memory address
    • sizeInBytes (UDINT): number of bytes
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer refers not to static area

memoryAreaIsNotUnkown

  • Parameters:
    • address (PVOID): memory address
    • sizeInBytes (UDINT): number of bytes
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer is not at memory area unknown

memoryAreaIsStatic

  • Parameters:
    • address (PVOID): memory address
    • sizeInBytes (UDINT): number of bytes
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer refers to static area

memoryAreaIsUnkown

  • Parameters:
    • address (PVOID): memory address
    • sizeInBytes (UDINT): number of bytes
    • message (AssertMessage): message if the assertion is false
  • Return type: VOID

This assertion method checks if pointer refers not to an unknown area

Code

Declaration

INTERFACE IPointerAssertions EXTENDS __SYSTEM.IQueryInterface