metaonly module xdc.rov.Model

The ROV Model is the core of ROV. The Model must be started in order to retrieve ROV views for any modules

The Model has a compatibility key. Any changes or additions to the public interfaces of the ROV core will result in a bump of the model version number.
Configuration settings sourced in xdc/rov/Model.xdc
var Model = xdc.useModule('xdc.rov.Model');
module-wide config parameters
module-wide functions
    Model.getIOFReaderInst// () returns Any
    Model.getMemoryImageInst// () returns Any
    Model.getModuleList// () returns Any
    Model.start// Start the ROV Model(Int vers, String executable, Any recap, ISymbolTable.Instance sym, Any mem, ICallBack.Instance callBack) returns Void
 
 
config Model.vers  // module-wide

ROV API version number

Configuration settings
Model.vers = Int 4;
 
DETAILS
Model.start will throw an exception if the version parameter does not equal the Model's current version. The version number is changed based on modifications to the public APIs (in xdc.rov.Program) that would potentially break compatibility with clients.
This allows the Model to verify compatibility with its client.
 
Model.getICallBackInst()  // module-wide
Configuration settings
Model.getICallBackInst() returns ICallBack.Instance
 
 
Model.getICallStackInst()  // module-wide
Configuration settings
Model.getICallStackInst() returns ICallStack.Instance
 
 
Model.getIOFReaderInst()  // module-wide
Configuration settings
Model.getIOFReaderInst() returns Any
 
 
Model.getISymbolTableInst()  // module-wide
Configuration settings
Model.getISymbolTableInst() returns ISymbolTable.Instance
 
 
Model.getMemoryImageInst()  // module-wide
Configuration settings
Model.getMemoryImageInst() returns Any
 
 
Model.getModuleList()  // module-wide
Configuration settings
Model.getModuleList() returns Any
 
 
Model.setICallStackInst()  // module-wide

Called only during Model initialization

Configuration settings
Model.setICallStackInst(ICallStack.Instance cs) returns Void
 
DETAILS
This method is called to "bind" an optional stack call stack parser and is called by the same client that calls Model.start().
 
Model.start()  // module-wide

Start the ROV Model

Configuration settings
Model.start(Int vers, String executable, Any recap, ISymbolTable.Instance sym, Any mem, ICallBack.Instance callBack) returns Void
 
ARGUMENTS
vers — Model.start will throw an exception if the version parameter does not equal the Model's current version.
recap — Capsule of the ROV recap file. Retrieve this with xdc.loadCapsule(recapFilePath).
executable — The path to the executable file
sym — an object that implements the xdc.rov.ISymbolTable interface used to read symbols defined by the executable
mem — an object that implements the xdc.rov.IMemoryImage interface used to read target memory
callBack — an object that implements the xdc.rov.ICallback interface used to report progress status
DETAILS
The ROV Model requires instances of an ISymbolTable, an IMemoryImage, and an ICallBack. It also requires the ROV recap file, which can be located using the xdc.rov.Recap module.
generated on Wed, 09 Aug 2017 16:38:11 GMT