metaonly module xdc.rov.monserver.ProgressCallBack
Configuration settings sourced in xdc/rov/monserver/ProgressCallBack.xdc
var ProgressCallBack = xdc.useModule('xdc.rov.monserver.ProgressCallBack');
per-instance config parameters
    var params = new ProgressCallBack.Params// Instance config-params object;
        params.args// Optional arguments to the callback = Any undefined;
per-instance creation
    var inst = ProgressCallBack.create// Create an instance-object(params);
per-instance functions
    inst.getAbortFlag// () returns Bool
    inst.updateStartupProgress// Progress update callback(Int percent, String message) returns Void
 
Instance Config Parameters

Configuration settings
var params = new ProgressCallBack.Params;
// Instance config-params object
    params.args = Any undefined;
    // Optional arguments to the callback
 
config ProgressCallBack.Params.args  // instance

Optional arguments to the callback

Configuration settings
var params = new ProgressCallBack.Params;
  ...
params.args = Any undefined;
 
Static Instance Creation

Configuration settings
var params = new ProgressCallBack.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = ProgressCallBack.create(params);
// Create an instance-object
 
ProgressCallBack.getAbortFlag()  // instance
Configuration settings
inst.getAbortFlag() returns Bool
 
 
ProgressCallBack.updateStartupProgress()  // instance

Progress update callback

Configuration settings
inst.updateStartupProgress(Int percent, String message) returns Void
 
DETAILS
The ROV model calls this API at particular points to update any startup progress provided by the client ROV tooling.
generated on Fri, 22 Feb 2019 01:33:21 GMT