metaonly module xdc.rta.tools.file.Main
index URL

Command implementation

XDCscript usage meta-domain sourced in xdc/rta/tools/file/Main.xdc
var Main = xdc.useModule('xdc.rta.tools.file.Main');
module-wide config parameters
    Main.usage// Usage for this command = String[] [
        ' ',
        'Usage',
        '[-p] [-h] [-m] [-e executable] [-x RTA XML file] [-d data input file] [-o output text file] [-c delimter character]',
        '[--help]',
        ' '
    ];
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.dataFile// Path to the file containing the RTA log data = String "";
        params.delimiter// // TODO [-l output file for load data] = String "|";
        params.executable// Path to the executable which was used to generate the data file = String "";
        params.more// Wait for the user to press enter before displaying the next packet = Bool false;
        params.outputFile// Optional path to an output file to write the decoded records to = String "";
        params.printToScreen// Whether to print the decoded records to the console = Bool false;
        params.rtaXml// Optional path to the RTA XML file = String "";
        params.suppressHeader// Don't print the header when printing the decoded records = Bool false;
per-instance functions
    inst.run// Underlying implementation(Cmdr.Instance cmdr, String[] args) returns Any
 
config Main.usage  // module-wide
index URL

Usage for this command

XDCscript usage meta-domain
Main.usage = String[] [
    ' ',
    'Usage',
    '[-p] [-h] [-m] [-e executable] [-x RTA XML file] [-d data input file] [-o output text file] [-c delimter character]',
    '[--help]',
    ' '
];
Main.exec()  // module-wide
index URL

'xs' script entry point

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

'xs' shell entry point

XDCscript usage meta-domain
Main.main(Any args) returns Any
Instance Config Parameters
index URL

XDCscript usage meta-domain
var params = new Main.Params;
// Instance config-params object
    params.dataFile = String "";
    // Path to the file containing the RTA log data
    params.delimiter = String "|";
    // // TODO [-l output file for load data]
    params.executable = String "";
    // Path to the executable which was used to generate the data file
    params.more = Bool false;
    // Wait for the user to press enter before displaying the next packet
    params.outputFile = String "";
    // Optional path to an output file to write the decoded records to
    params.printToScreen = Bool false;
    // Whether to print the decoded records to the console
    params.rtaXml = String "";
    // Optional path to the RTA XML file
    params.suppressHeader = Bool false;
    // Don't print the header when printing the decoded records
config Main.dataFile  // instance
index URL

Path to the file containing the RTA log data

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.dataFile = String "";
config Main.delimiter  // instance
index URL

// TODO [-l output file for load data]

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.delimiter = String "|";
DETAILS
Delimiter character to use when writing out the file.
The character specified here will be inserted between each of the record fields so that the file can be imported into a spreadsheet such as excel.
config Main.executable  // instance
index URL

Path to the executable which was used to generate the data file

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.executable = String "";
config Main.more  // instance
index URL

Wait for the user to press enter before displaying the next packet

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.more = Bool false;
DETAILS
Without this flag, the tool will simply print all of the records in the data file to the screen. If this flag is set, then the tool will wait the user to press enter in between displaying each packet.
config Main.outputFile  // instance
index URL

Optional path to an output file to write the decoded records to

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.outputFile = String "";
DETAILS
The tool will write the decoded records out as text to the specified out file. The record properties will be separated with a delimeter character so that they can be imported into a spreadsheet such as Excel.
config Main.printToScreen  // instance
index URL

Whether to print the decoded records to the console

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.printToScreen = Bool false;
DETAILS
You may use this tool to simply print the decoded records, or you may have them redirected to a file to be processed elsewhere.
config Main.rtaXml  // instance
index URL

Optional path to the RTA XML file

XDCscript usage meta-domain
var params = new Main.Params;
  ...
params.rtaXml = String "";
config Main.suppressHeader  // instance
index URL

Don't print the header when printing the decoded records

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

Underlying implementation

XDCscript usage meta-domain
inst.run(Cmdr.Instance cmdr, String[] args) returns Any
generated on Tue, 24 Aug 2010 15:39:43 GMT