metaonly module xdc.rov.ViewInfo

Describes the ROV views supported by a particular module

Configuration settings sourced in xdc/rov/ViewInfo.xdc
var ViewInfo = xdc.useModule('xdc.rov.ViewInfo');
module-wide constants & types
    values of type ViewInfo.ViewType// ROV view type
        const ViewInfo.INSTANCE;
        const ViewInfo.MODULE;
        const ViewInfo.INSTANCE_DATA;
        const ViewInfo.MODULE_DATA;
        const ViewInfo.RAW;
        const ViewInfo.TREE_TABLE;
        const ViewInfo.TREE;
 
    var obj = new ViewInfo.View// ROV View descriptor;
        obj.type = ViewInfo.ViewType  ...
        obj.viewInitFxn = String  ...
        obj.structName = String  ...
per-instance config parameters
    var params = new ViewInfo.Params// Instance config-params object;
        params.showRawTab// Control whether the "raw view" is available = Bool true;
        params.viewMap// Specifies all of the ROV views for the module = ViewInfo.View[string] undefined;
 
 
enum ViewInfo.ViewType

ROV view type

Configuration settings
values of type ViewInfo.ViewType
    const ViewInfo.INSTANCE;
    const ViewInfo.MODULE;
    const ViewInfo.INSTANCE_DATA;
    const ViewInfo.MODULE_DATA;
    const ViewInfo.RAW;
    const ViewInfo.TREE_TABLE;
    const ViewInfo.TREE;
 
DETAILS
INSTANCE
basic instance information (one row per instance). The view init function is passed two arguments: (1) an instance of the view structure, and (2) the instance state structure of the instance to view.
INSTANCE_DATA
instance-specific data tables (many rows per instance). The view init function is passed two arguments:(1) an instance of the xdc.rov.Program.InstDataView structure, and (2) an instance state structure for the instance to view.
MODULE
basic module information (one row per module). The view init function is passed two arguments: (1) an instance of the view structure, and (2) the module state structure of the module to view.
MODULE_DATA
module-specific data tables (many rows per module). The view init function is passed one argument: a Program.ModDataView structure.
RAW
This is a reserved view type used by ROV to display raw data.
TREE_TABLE
The view init function is passed no arguments and is expected to return a new initialized xdc.rov.Program.TreeNode structure or null in the event that there is nothing to display.
TREE
The view init function is passed no arguments and is expected to return a new initialized JavaScript hash table or null in the event that there is nothing to display.
 
struct ViewInfo.View

ROV View descriptor

Configuration settings
var obj = new ViewInfo.View;
 
    obj.type = ViewInfo.ViewType  ...
    obj.viewInitFxn = String  ...
    obj.structName = String  ...
 
FIELDS
type — the view type which control the type of arguments passed to the viewInitFxn
viewInitFxn — the name of a function that converts raw target data into a human readable "view structure". This name is the name of a metaonly function defined in the module's .xs file.
structName — the name of the view structure populated by the viewInitFxn. This name is a name defined the module's .xdc file.
Instance Config Parameters

Configuration settings
var params = new ViewInfo.Params;
// Instance config-params object
    params.showRawTab = Bool true;
    // Control whether the "raw view" is available
    params.viewMap = ViewInfo.View[string] undefined;
    // Specifies all of the ROV views for the module
 
config ViewInfo.Params.showRawTab  // instance

Control whether the "raw view" is available

Configuration settings
var params = new ViewInfo.Params;
  ...
params.showRawTab = Bool true;
 
 
config ViewInfo.Params.viewMap  // instance

Specifies all of the ROV views for the module

Configuration settings
var params = new ViewInfo.Params;
  ...
params.viewMap = ViewInfo.View[string] undefined;
 
DETAILS
Maps module-specific view names to an appropriate View descriptor.
generated on Wed, 09 Apr 2014 00:37:38 GMT