Evriaddon

From Eigenvector Research Documentation Wiki
Revision as of 13:21, 16 April 2010 by imported>Scott (Created page with '===Purpose=== Create an Eigenvector Add-On object. ===Synopsis=== :list = evriaddon(entrypoint) ===Description=== EVRIADDON objects allows add-on products to indicate to PLS_T…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Purpose

Create an Eigenvector Add-On object.

Synopsis

list = evriaddon(entrypoint)

Description

EVRIADDON objects allows add-on products to indicate to PLS_Toolbox that they contain specific add-on funcitonality which is specifically queried by certain PLS_Toolbox functions. A product can add itself to PLS_Toolbox by simply creating an @evriaddon folder in its main folder. Within this folder, the application should create a single m-file named for the add-on product after a prefix of "addon_". For example: mia_toolbox -> addon_mia_toolbox.m This function should create an instance of an evriaddon_connection object (including an optional descriptive name of the add-on product) and then assign function handles to any of the entry points available within that connector. For example, within a folder named @evriaddon, the following function could be created:

function out = addon_mytoolbox(obj)
out = evriaddon_connection('My Toolbox'); 
out.importmethods = @myimport_methodlist;

evriaddon_connection entry points can be assigned as single function handles or as a cell array of function handles. Entry points in PLS_Toolbox needing to retrieve the list of function handles requesting calls into it should call evriaddon with the single input of the entry point name:

list = evriaddon('importmethods');

returns (list) as a cell array of function handles requesting calls.

See Also

editds importmethods