Xcos Public API

This is the list of the Xcos public API. This Scilab functions/macros will be preserved across each Xcos release.

importXcosDiagram

function result = importXcosDiagram(xcosFile)

result

Boolean

true on success, false otherwise

xcosFile

String

relative or absolute path to the Xcos diagram file

Load an Xcos diagram on the Scilab interpreter. The resulting diagram is loaded on an scs_m structure with a scicos mlist format.

(!) This function doesn't load the Scicos libraries and doesn't need them.

loadScicosLibs

function loadScicosLibs()

Load the Scicos engine libraries on Scilab.

xcos_run

function xcos_run(xcosFile)

xcosFile

String

relative or absolute path to the Xcos diagram file

Simulate the Xcos diagram. The function has the same behavior than the scicos_run but take an xcos diagram file instead of a diagram mlist.

(!) This function need the Scicos libraries to be loaded before use.


CategoryXcos

public: Xcos/PublicAPI (last edited 2011-03-30 16:18:19 by localhost)