Introduction

Interfaces

root/

root/utils

Data structures

Examples

ValidationFunctions

  Copyright (C) 2009-2015 Peter Rakyta, Ph.D.

  This program is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program.  If not, see http://www.gnu.org/licenses/.

Description

Provides an interface for validating variables for their usage in functions.

Syntax

interface = ValidationFunctions()

Methods

Validating_kx_and_ky
ValidatingFieldNames

Validating_kx_and_ky

ValidationFunctions::Validating_kx_and_ky

Checking mesh grids kx and ky.

Syntax

ret = interface.Validating_kx_and_ky( kx, ky )

Parameters
kx	A meshgrid of real numbers.
ky	A meshgrid of real numbers.

Return
ret	Return with 0 if the arguments passed, 1 otherwise.

ValidatingFieldNames

ValidationFunctions::ValidatingFieldNames

Checks the field names of a structure.

Syntax

ret = interface.ValidatingFieldNames( expected_fieldnames, structure_name, structure, varargin )

Parameters
expected_fieldnames	Cells containing the expected field names.
structure_name	The name of the tested structure.
structure	The tested structure.
varargin	Optional parameters given by a sequence ...'name', value,... . Possible parameters are: Isstruct set 'On' to test whether the given "structure" is a structure or not. FieldNumber set 'On' to test whether the length of expected field names is equal to the number of the fields in the given "structure". Ismember

Return
ret	Return with 0 if the test passed, 1 otherwise.