metaonly interface xdc.tools.product.IProductView
index URL

Define a product as a logical group of RTSC modules

This interface allows a product to define logical groups of RTSC modules delivered with it. Implementations of this interface are typically consumed within development environments like IDE's to render a graphical tree view of the product consisting of these groups. [ more ... ]
XDCspec summary sourced in xdc/tools/product/IProductView.xdc
metaonly interface IProductView {  ...
XDCspec declarations sourced in xdc/tools/product/IProductView.xdc
package xdc.tools.product;
 
metaonly interface IProductView {
module-wide constants & types
    metaonly struct ProductElemDesc// ProductElemDesc structure {
        String elemName// Name of group or module;
        String moduleName// Name of module;
        String iconFileName// Icon file name representing element;
        IProductView.ProductElemDesc elemArray// Array of ProductElemDesc[];
    };
module-wide config parameters
    config String homeModule// Top-level module for this product;
    config String linksToArray// Array of IDs of products accessable from this product's home module[];
module-wide functions
    IProductView.ProductElemDesc getProductDescriptor// Return this product's tree view();
}
DETAILS
This interface allows a product to define logical groups of RTSC modules delivered with it. Implementations of this interface are typically consumed within development environments like IDE's to render a graphical tree view of the product consisting of these groups.
This is an experimental interface and is subject to change.
 
struct IProductView.ProductElemDesc
index URL

ProductElemDesc structure

XDCspec declarations sourced in xdc/tools/product/IProductView.xdc
metaonly struct ProductElemDesc {
    String elemName;
    // Name of group or module
    String moduleName;
    // Name of module
    String iconFileName;
    // Icon file name representing element
    IProductView.ProductElemDesc elemArray[];
    // Array of ProductElemDesc
};
 
FIELDS
elemName — Name of element. Elements can be either groups or modules
moduleName — In case of a leaf node this field will contain the module name. For intermediate tree nodes the module name will be set to null
iconFileName — The name of the icon file that is associated with this element. In xdctools 3.23, this path must be relative to the package containing the IProductView implementation.
In xdctools 3.24.01 (or above), this path may be relative or absolute. If it's relative, it's first searched for in the package containing the IProductView implementation module and, if this fails, the relative path is searched via xdc.findFile(). If the icon is still not found, a default icon will be used.
elemArray — Array used to define children of a node.
DETAILS
This structure is used to define the logical tree "view" of a product. This view is composed of elements that are either modules or groups: modules at the leaves of the tree and groups elsewhere.
 
config IProductView.homeModule  // module-wide
index URL

Top-level module for this product

XDCspec declarations sourced in xdc/tools/product/IProductView.xdc
config String homeModule;
 
DETAILS
The homeModule is a distinguished "top-level" module that is used by GUI's as a starting point, or "home page", to navigate to the other content managed by this product.
 
config IProductView.linksToArray  // module-wide
index URL

Array of IDs of products accessable from this product's home module

XDCspec declarations sourced in xdc/tools/product/IProductView.xdc
config String linksToArray[];
 
DETAILS
This array of product IDs is used to determine a hierarchical relationship between products and if a product's modules can be reached from another product's home page. If product A "links to" product B, then product B's home page can be closed so long as product A's home page is open.
 
IProductView.getProductDescriptor()  // module-wide
index URL

Return this product's tree view

XDCspec declarations sourced in xdc/tools/product/IProductView.xdc
IProductView.ProductElemDesc getProductDescriptor();
 
DETAILS
This method is typically invoked by development tools like IDE's to get the product view tree structure.
RETURNS
Returns root node of tree of ProductElemDesc structures
generated on Thu, 27 Sep 2012 23:21:16 GMT