metaonly module xdc.rov.ViewInfo |
 |
 |
 |
Describes the ROV views supported by a particular module
var ViewInfo = xdc.useModule('xdc.rov.ViewInfo');
module-wide constants & types
per-instance config parameters
enum ViewInfo.ViewType |
 |
ROV view type
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 three arguments: (1) an instance of
the view structure, (2) the instance state structure of the
instance to view, and (3) a string containing user-supplied
arguments.
- INSTANCE_DATA
-
instance-specific data tables (many rows per instance). The
view init function is passed three arguments: (1) an instance
of the
Program.InstDataView
structure, (2) an instance state structure for the
instance to view, and (3) a string containing user-supplied
arguments.
- MODULE
-
basic module information (one row per module). The view
init function is passed three arguments: (1) an instance of
the view structure, (2) the module state structure of the
module to view, and (3) a string containing user-supplied
arguments.
- MODULE_DATA
-
module-specific data tables (many rows per module). The
view init function is passed two arguments: (1) a
Program.ModDataView
structure, and (2) a string containing user-supplied
arguments.
- RAW
-
This is a reserved view type used by ROV to display raw data.
- TREE_TABLE
-
The view init function is passed one argument: a string
containing user-supplied arguments. It is expected
to return a new initialized
xdc.rov.Program.TreeNode
array or null in the event that there is nothing to
display.
This view type is used to describe the Diags masks
for all modules, for example; see
Diags.rovViewInfo'
- TREE
-
The view init function is passed one argument: a string
containing user-supplied arguments. It is expected
to return a new initialized JavaScript hash table of hash
tables or null in the event that there is nothing to display.
This view type provides a simple two-level tree of name-value
pairs.
struct ViewInfo.Arg |
 |
var obj = new ViewInfo.Arg;
obj.name = String ...
// the name displayed to the user
obj.type = String ...
// the type of this argument:
"string", "number", "boolean"
obj.defaultValue = String ...
// the default value of this argument
struct ViewInfo.Args |
 |
var obj = new ViewInfo.Args;
obj.description = String ...
// the description shown to the user
// the argument in positional order
struct ViewInfo.View |
 |
ROV View descriptor
var obj = new ViewInfo.View;
obj.viewInitFxn = String ...
obj.structName = String ...
obj.argsName = 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.
argsName
the name of an Args descriptor that defines the
user-supplied arguments for this view.
argsName is used to index into argsMap.
Instance Config Parameters |
 |
var params = new ViewInfo.Params;
// Instance config-params object
// Specifies argument structures for all of a module's views
params.showRawTab = Bool true;
// Control whether or not the "raw view" is available
// Specifies all of the ROV views for the module
config ViewInfo.Params.argsMap // instance |
 |
Specifies argument structures for all of a module's views
var params = new ViewInfo.Params;
...
DETAILS
Maps module-specific argument sets to an appropriate Args descriptor.
config ViewInfo.Params.showRawTab // instance |
 |
Control whether or not the "raw view" is available
var params = new ViewInfo.Params;
...
params.showRawTab = Bool true;
config ViewInfo.Params.viewMap // instance |
 |
Specifies all of the ROV views for the module
var params = new ViewInfo.Params;
...
DETAILS
Maps module-specific view names to an appropriate View descriptor.
generated on Wed, 09 Aug 2017 16:38:11 GMT