Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Steps 1 and 3 are automated using the awe_generate_library.m command.  Many other MATLAB functions are internally called. Only a few other functions are documented here to help you better understand the code generation process.  Step 4 is done separately in VisualStudio and described in (8.D.2.6) Generating Documentation.

...

Template substitution is an automated method of replacing strings within a file to generate an output file.  The process starts with a template file and Audio Weaver provides separate templates for the generated module .c and .h files:

  • <AWE>\matlab\module_generation\templates\awe_module_template.h

  • <AWE>\matlab\module_generation\templates\awe_module_template.c

...

  • M — @awe_module object.

  • DIRECTORY — directory in which the generated files should be written to.  By default, this is set to MATLAB's current working directory (returned by the pwd command).

  • WRITEFILES — an optional Boolean argument which specifies whether the generated files should actually be written.  If you set WRITEFILES=0, then the module M will be updated with code markers, but no output files will be written.  Use WRITEFILES=0 when generating documentation as described in (8.D.2.6) Generating Documentation.