Changes between Version 11 and Version 12 of MATLAB API

Timestamp:

11/19/13 11:05:37 (11 years ago)

Author:

jorisborgdorff

Comment:

--

MATLAB API

@@ -24 +24 @@
 data = muscleReceive('exit', data_type)
 }}}
-== CxA ==
-All MATLAB kernels should use as their implementation `muscle.core.standalone.MatlabKernel`, e.g.
+
+Due to mismatch between C and MATLAB datatypes, only a subset of the datatypes supported in the C API is available in the MATLAB API, namely:
+* `MUSCLE_DOUBLE` - array of doubles
+* `MUSCLE_STRING` - character string
+* `MUSCLE_INT32` - array of integers
+* `MUSCLE_BOOLEAN` - array of logicals
+
+In the MUSCLE configuration file, kernels should use the `muscle.core.standalone.MatlabKernel` class or its subclass as their implementation, e.g.,
 {{{
 w = Instance.new('w', 'muscle.core.standalone.MatlabKernel')
 }}}
-== Supported !DataTypes ==
-Due to huge mismatch between the C and MATLAB datatypes only subset of datatypes supported in the C API is available in the MATLAB API, namely:
-* MUSCLE_DOUBLE
-* MUSCLE_STRING
-* MUSCLE_INT32
-* MUSCLE_BOOLEAN
+
 == Example ==
-* sender.m
+
+In the `src/matlab/examples/simplematlab` is an example of a kernel using the MATLAB API to send an array of doubles. This array is then received by the ConsoleWriter class, as specified in the configuration file `src/cxa/SimpleMatlabExample.cxa.rb`.
+
+* The `sender.m` MATLAB script is as follows:
 {{{
 
@@ -58 +62 @@
 }}}
 
-* example session:
+* And a session using this script outputs the following:
 {{{
 Running both MUSCLE2 Simulation Manager and the Simulation
@@ -137 +141 @@
 
         Executed in </scratch/41450320.batch.grid.cyf-kr.edu.pl/n1245-g7e.zeus_2013-11-15_15-32-58_8575>
-
-
 }}}