metaonly module ti.xdais.qualiti.Main
Configuration settings sourced in ti/xdais/qualiti/Main.xdc
var Main = xdc.useModule('ti.xdais.qualiti.Main');
module-wide config parameters
    Main.usage// usage help message = String[] [
        '[-h] [-u file] [-o outDir] [-ol] [-e] [-t toolsIniFile] ',
        '[-d 0|1|2] [-f] [-v|q] [-g] algproject',
        ' -u: run user script',
        '(following options in command-line mode only)',
        ' -o: output HTML reports to outDir',
        ' -l: output HTML reports in the algorithm library dir',
        ' (default is in the algorithm base dir)',
        ' -e: embed time stamp in the report filename',
        ' -t: specify alternative Tools.ini file with toolpaths',
        ' -d: report detail level',
        ' -f: make report diff friendly',
        ' -v: verbose',
        ' -q: quiet',
        ' algproject: a .qti file with algorithm description'
    ];
module-wide functions
    Main.createPartControl// (Any parent) returns Any
    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.diffFriendly// Make report diff friendly = Bool false;
        params.gui// Gui = Bool false;
        params.help// help = Bool false;
        params.outputDir// HTML report output in a specified directory = String null;
        params.quiet// Quiet = Bool false;
        params.testDetailLevel// Test detail level = Int 2;
        params.toolsIniFile// Alternative Tools.ini file (full path) = String null;
        params.userIniFile// User script to run before the main script = String null;
        params.verbose// Verbose = Bool false;
per-instance functions
    inst.run// Underlying implementation of the command(Cmdr.Instance cmdr, String[] args) returns Any
 
 
config Main.usage  // module-wide

usage help message

Configuration settings
Main.usage = String[] [
    '[-h] [-u file] [-o outDir] [-ol] [-e] [-t toolsIniFile] ',
    '[-d 0|1|2] [-f] [-v|q] [-g] algproject',
    ' -u: run user script',
    '(following options in command-line mode only)',
    ' -o: output HTML reports to outDir',
    ' -l: output HTML reports in the algorithm library dir',
    ' (default is in the algorithm base dir)',
    ' -e: embed time stamp in the report filename',
    ' -t: specify alternative Tools.ini file with toolpaths',
    ' -d: report detail level',
    ' -f: make report diff friendly',
    ' -v: verbose',
    ' -q: quiet',
    ' algproject: a .qti file with algorithm description'
];
 
 
Main.createPartControl()  // module-wide
Configuration settings
Main.createPartControl(Any parent) returns Any
 
 
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.diffFriendly = Bool false;
    // Make report diff friendly
    params.embedTimeStampInReportName = Bool false;
    // Embed time stamp in HTML report filename
    params.gui = Bool false;
    // Gui
    params.help = Bool false;
    // help
    params.outputDir = String null;
    // HTML report output in a specified directory
    params.outputInLibDir = Bool false;
    // HTML report output in alg. lib directory and not base directory
    params.quiet = Bool false;
    // Quiet
    params.testDetailLevel = Int 2;
    // Test detail level
    params.toolsIniFile = String null;
    // Alternative Tools.ini file (full path)
    params.userIniFile = String null;
    // User script to run before the main script
    params.verbose = Bool false;
    // Verbose
 
config Main.Params.diffFriendly  // instance

Make report diff friendly

Configuration settings
var params = new Main.Params;
  ...
params.diffFriendly = Bool false;
 
 
config Main.Params.embedTimeStampInReportName  // instance

Embed time stamp in HTML report filename

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

Gui

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

help

Configuration settings
var params = new Main.Params;
  ...
params.help = Bool false;
 
 
config Main.Params.outputDir  // instance

HTML report output in a specified directory

Configuration settings
var params = new Main.Params;
  ...
params.outputDir = String null;
 
 
config Main.Params.outputInLibDir  // instance

HTML report output in alg. lib directory and not base directory

Configuration settings
var params = new Main.Params;
  ...
params.outputInLibDir = Bool false;
 
 
config Main.Params.quiet  // instance

Quiet

Configuration settings
var params = new Main.Params;
  ...
params.quiet = Bool false;
 
 
config Main.Params.testDetailLevel  // instance

Test detail level

Configuration settings
var params = new Main.Params;
  ...
params.testDetailLevel = Int 2;
 
 
config Main.Params.toolsIniFile  // instance

Alternative Tools.ini file (full path)

Configuration settings
var params = new Main.Params;
  ...
params.toolsIniFile = String null;
 
 
config Main.Params.userIniFile  // instance

User script to run before the main script

Configuration settings
var params = new Main.Params;
  ...
params.userIniFile = String null;
 
 
config Main.Params.verbose  // instance

Verbose

Configuration settings
var params = new Main.Params;
  ...
params.verbose = Bool false;
 
 
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:28 GMT