2.2 command-line

Function File: fevalstruct ( name, argstruct )

Function File: fevalstruct ( …, property, value, … )

Evaluate the function named name, using the keyword-value arguments given by argstruct.

If property "stripempty" is true, empty fields are first removed from argstruct.

Examples

args = struct;
args.real_strictpos_scalar = 1.23;
args.integer_vector = [-5, 3];
args.string = "Hi";
args.cell = {1, 9};
fevalstruct(@__test_parseOptions__, args);

Function File: parseOptions ( opts, optspec, optspec, … )

Function File: paropts = parseOptions ( … )

Function File: [ •, paropts ] = parseOptions ( … )

Kitchen-sink options parser.

Arguments

opts

function options

optspec

option specification, one of:

required option

{name, types}

optional option

{name, types, defvalue}

where:

name

name of option variable

types

datatype specification of option: ’type,type,…’

defvalue

default value given to <name>

paropts

struct of parsed function options (optional)

Notes

• using the 1st or 3rd syntax, name will be assigned in the context of the calling function; using the 2nd or 3rd syntax, name will be assigned in the return struct.
• each type in types must correspond to a function istype(): each function will be called to check that a value is valid. For example, if types = ’numeric,scalar’ then a value x must satisfy isnumeric(x) && isscalar(x)
• opts should contain options of the form

    reg, reg, ..., "key", val, "key", val, ...
  

  where reg are regular options, and key and val are keyword-value option pairs. Regular options are assigned in the order they were given as optspecs; regular options may also be given as keyword-values.

Examples

See the tutorial on parseOptions().

Function File: writeCommandLineToFile ( filename, params, scriptname )

write an octapps_run commandline as an output file header ’params’ should be prepared by parseOptions() before

Note

use save("-append",...) later on to not overwrite this header

Examples

args = struct;
args.real_strictpos_scalar = 1.23;
args.integer_vector = [-5, 3];
args.string = "Hi";
writeCommandLineToFile(tempname(tempdir), args, "__test_parseOptions__")