Check Required Properties

Class: kwave.toolbox.GridInput Package: kwave.toolbox

Validates that the essential properties of the input object are defined.

Syntax

checkRequiredProperties(obj)

Description

Ensures that all critical properties, as specified in the obj.requiredProperties cell array, are defined and not empty. This method is intended to be called by the kWaveSolver constructor to guarantee that the input object is in a valid state before proceeding with a simulation. If any required property is not defined, the GridInput:missingInput error is thrown, informing the user of the missing property.

Input Arguments

  • obj - (kwave.toolbox.GridInput) An instance of the kwave.toolbox.GridInput class. This object's requiredProperties attribute determines which properties must be checked.