metaonly module ti.xdais.wizards.genalg.Main

XDM GenAlg wizard

Configuration settings sourced in ti/xdais/wizards/genalg/Main.xdc
var Main = xdc.useModule('ti.xdais.wizards.genalg.Main');
module-wide config parameters
        '[-g] [--cgtools <dir>] [--gcccgtools <dir>] [--m3cgtools <dir>] [-f <file> | --xml <file>] [-d <destination dir>]'
    ];
module-wide functions
    Main.exec// xs script entry point(Any args) returns Any
    Main.main// xs shell entry point(Any args) returns Any
per-instance config parameters
    var params = new Main.Params// Instance config-params object;
        params.cgTools// TI C6000 codegen tools directory = String null;
        params.destDir// package destination directory = String null;
        params.gccCgTools// GCC codegen tools directory = String null;
        params.gui// Gui = Bool false;
        params.m3cgTools// m3 codegen tools directory = String null;
        params.xmlFile// XML File containing saved user input = String null;
per-instance functions
    inst.run// Underlying implementation of the command(Cmdr.Instance cmdr, String[] args) returns Any
 
 
config Main.usage  // module-wide

Usage for this command

Configuration settings
Main.usage = String[] [
    '[-g] [--cgtools <dir>] [--gcccgtools <dir>] [--m3cgtools <dir>] [-f <file> | --xml <file>] [-d <destination dir>]'
];
 
 
Main.exec()  // module-wide

xs script entry point

Configuration settings
Main.exec(Any args) returns Any
 
DETAILS
This function is called from within other XDCscript scripts and performs the same operations as main() except that, rather than output the return value of inst.run(), this value is simply returned to the caller of exec().
 
Main.main()  // module-wide

xs shell entry point

Configuration settings
Main.main(Any args) returns Any
 
DETAILS
This function
  • creates a no-arg instance, inst, of the module inheriting this interface;
  • parses command line arguments placing all options in the config params of the inheriting module;
  • creates a xdc.tools.Cmdr instance, cmdr;
  • calls inst.run() with the cmdr and any command line command line arguments not parsed as options; and
  • outputs the return result from inst.run()
Instance Config Parameters

Configuration settings
var params = new Main.Params;
// Instance config-params object
    params.cgTools = String null;
    // TI C6000 codegen tools directory
    params.destDir = String null;
    // package destination directory
    params.gccCgTools = String null;
    // GCC codegen tools directory
    params.gui = Bool false;
    // Gui
    params.m3cgTools = String null;
    // m3 codegen tools directory
    params.xmlFile = String null;
    // XML File containing saved user input
 
config Main.Params.cgTools  // instance

TI C6000 codegen tools directory

Configuration settings
var params = new Main.Params;
  ...
params.cgTools = String null;
 
 
config Main.Params.destDir  // instance

package destination directory

Configuration settings
var params = new Main.Params;
  ...
params.destDir = String null;
 
 
config Main.Params.gccCgTools  // instance

GCC codegen tools directory

Configuration settings
var params = new Main.Params;
  ...
params.gccCgTools = String null;
 
 
config Main.Params.gui  // instance

Gui

Configuration settings
var params = new Main.Params;
  ...
params.gui = Bool false;
 
 
config Main.Params.m3cgTools  // instance

m3 codegen tools directory

Configuration settings
var params = new Main.Params;
  ...
params.m3cgTools = String null;
 
 
config Main.Params.xmlFile  // instance

XML File containing saved user input

Configuration settings
var params = new Main.Params;
  ...
params.xmlFile = String null;
 
 
Main.run()  // instance

Underlying implementation of the command

Configuration settings
inst.run(Cmdr.Instance cmdr, String[] args) returns Any
 
DETAILS
Since this method is used to support both command line tools and other XDCscript scripts, it is important to avoid explicit termination of the JVM via java.lang.System.exit(); doing so precludes callers from handling failures.
Implementations should instead call
generated on Tue, 28 Jun 2016 21:14:29 GMT