metaonly module ti.xdais.qualiti.Main
XDCspec summary sourced in ti/xdais/qualiti/Main.xdc
metaonly module Main {  ...
// inherits xdc.tools.ICmd
instance:  ...
XDCscript usage meta-domain
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( Cmdr.Instance cmdr, String[] args ) returns Any
 
XDCspec declarations sourced in ti/xdais/qualiti/Main.xdc
package ti.xdais.qualiti;
 
metaonly module Main inherits ICmd {
module-wide config parameters
    override config String usage// usage help message[] = [
        '[-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
    function createPartControl// ( parent );
 
 
instance:
per-instance config parameters
    config Bool diffFriendly// Make report diff friendly = false;
    config Bool gui// Gui = false;
    config Bool help// help = false;
    config Bool quiet// Quiet = false;
    config Int testDetailLevel// Test detail level = 2;
    config Bool verbose// Verbose = false;
per-instance functions
    Any run// Underlying implementation( Cmdr.Instance cmdr, String args[] );
}
 
config Main.usage  // module-wide

usage help message

XDCscript usage meta-domain
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
XDCscript usage meta-domain
Main.createPartControl( Any parent ) returns Any
 
 
Main.exec( )  // module-wide

'xs' script entry point

XDCscript usage meta-domain
Main.exec( Any args ) returns Any
 
 
Main.main( )  // module-wide

'xs' shell entry point

XDCscript usage meta-domain
Main.main( Any args ) returns Any
 
 
per-instance config parameters

XDCscript usage meta-domain
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.diffFriendly  // per-instance

Make report diff friendly

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.diffFriendly = Bool false;
 
 
config Main.embedTimeStampInReportName  // per-instance

Embed time stamp in HTML report filename

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.embedTimeStampInReportName = Bool false;
 
 
config Main.gui  // per-instance

Gui

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.gui = Bool false;
 
 
config Main.help  // per-instance

help

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.help = Bool false;
 
 
config Main.outputDir  // per-instance

HTML report output in a specified directory

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.outputDir = String null;
 
 
config Main.outputInLibDir  // per-instance

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

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.outputInLibDir = Bool false;
 
 
config Main.quiet  // per-instance

Quiet

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.quiet = Bool false;
 
 
config Main.testDetailLevel  // per-instance

Test detail level

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.testDetailLevel = Int 2;
 
 
config Main.toolsIniFile  // per-instance

Alternative Tools.ini file (full path)

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.toolsIniFile = String null;
 
 
config Main.userIniFile  // per-instance

User script to run before the main script

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.userIniFile = String null;
 
 
config Main.verbose  // per-instance

Verbose

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.verbose = Bool false;
 
 
Main.run( )  // per-instance

Underlying implementation

XDCscript usage meta-domain
inst.run( Cmdr.Instance cmdr, String[] args ) returns Any
 
generated on Mon, 20 Sep 2010 23:50:10 GMT