Matlab Bindings - Revision history

Dickon Champion at 16:27, 16 May 2008

2008-05-16T16:27:13Z

Dickon Champion: /* write an appropriate matlab function */

2008-05-16T16:23:45Z

write an appropriate matlab function

Dickon Champion: /* write an appropriate matlab function */

2008-05-16T16:07:11Z

write an appropriate matlab function

Dickon Champion: /* write an appropriate matlab function */

2008-05-16T15:51:10Z

write an appropriate matlab function

Dickon Champion: /* define object subroutine pair in `bindings/matlab/libisisexc.txt` */

2008-05-16T14:04:27Z

define object subroutine pair in <tt>bindings/matlab/libisisexc.txt</tt>

Dickon Champion: /* define object subroutine pair in `bindings/matlab/libisisexc.txt` */

2008-05-16T14:03:06Z

define object subroutine pair in <tt>bindings/matlab/libisisexc.txt</tt>

Dickon Champion: /* define object subroutine pair in `libisisexc.txt` */

2008-05-16T14:01:38Z

define object subroutine pair in <tt>libisisexc.txt</tt>

Dickon Champion: /* preprocessing operations */

2008-05-16T13:45:31Z

preprocessing operations

Dickon Champion: /* preprocessing operations */

2008-05-16T13:44:45Z

preprocessing operations

Dickon Champion: /* define an appropriate binding subroutine in `IXMclassname_m.f90` */

2008-05-16T10:49:24Z

define an appropriate binding subroutine in <tt>IXMclassname_m.f90</tt>

@@ Line 241: / Line 241: @@
 </pre>
-the arguments to <tt>libisisexc()</tt> are directly related to the variables
+the arguments to <tt>libisisexc()</tt> are directly related to the variables used in <tt>IXBplus_testclass</tt>
 <tt>
-* prhs(1) => IXTtestclass
+* prhs(1) => IXTtestclass ,</tt>(empty objectused to populate return result)<tt>
-* prhs(2) => a </tt> (a is a populated IXTtestclass object)<tt>
+* prhs(2) => a </tt> (a is a populated IXTtestclass object input argument)<tt>
-* prhs(3) => b </tt> (a is a populated IXTtestclass object)<tt>
+* prhs(3) => b </tt> (a is a populated IXTtestclass object input argument)<tt>
 * prhs(4) => array
 </tt>

@@ Line 211: / Line 211: @@
 </pre>
-The constructor defines the data within a class and the order that these members are in if the class in indexed. It is thus important that the order defined in this class is followed '''EXACTLY''' in fortran when calling <tt>IXFoperationRun_classname</tt>. In our case the constructor should populate a default empty object and then pass this empty object and any arguments out to LIBISIS with a call to <tt>libisisexc()</tt>, which will check the arguments and then complete creation of the object. The first two string arguments to <tt>libisisexc()</tt> are the <tt>classname</tt> and <tt>method</tt>, inside the DLL they are mangled together and the DLL then calls the appropriate <tt>IXBmethod_classname</tt>, provided it has been defined in <tt>libisisexc.txt</tt> see [[Matlab Bindings#define object method pair in bindings/matlab/libisisexc.txt
+The constructor defines the data within a class and the order that these members are in if the class in indexed. It is thus important that the order defined in this class is followed '''EXACTLY''' in fortran when calling <tt>IXFoperationRun_classname</tt>. In our case the constructor should populate a default empty object and then pass this empty object and any arguments out to LIBISIS with a call to <tt>libisisexc()</tt>, which will check the arguments and then complete creation of the object. The first two string arguments to <tt>libisisexc()</tt> are the <tt>classname</tt> and <tt>method</tt>, inside the DLL they are mangled together and the DLL then calls the appropriate <tt>IXBmethod_classname</tt>, provided it has been defined in <tt>libisisexc.txt</tt>.
 <pre>
-function testclass = IXTtestclass(varargin)
+function object = IXTtestclass(varargin)
+object.base = IXTbase;
-testclass.base = IXTbase;
+object.val = 0;
-testclass.val = 0;
+object.nx = int32(1);
-testclass.nx = int32(1);
+object.val_static = ones(3);
-testclass.val_static = ones(3);
+object.int_static =  ones(4);
-testclass.int_static =  ones(4);
+object.val_array = zeros(2);
-testclass.val_array = zeros(2);
+object.int_arr = int32(zeros(2,2));
-testclass.int_arr = int32(zeros(2,2));
+object.spectra = IXTspectra;
-testclass.spectra = IXTspectra;
+object.xhist = true;
-testclass.xhist = true;
+object.label='test';
-testclass.label='test';
+object.cell_string = [ 'one' ];
-testclass.cell_string = [ 'one' ];
+object.d2d = [ IXTdataset_2d ];
-testclass.d2d = [ IXTdataset_2d ];
+object = class(object ,'IXTtestclass');
 if (nargin > 0)
-     testclass = libisisexc('IXTtestclass','create',testclass,varargin);
+     object = libisisexc('IXTtestclass','create',object ,varargin);
 end
 </pre>

@@ Line 194: / Line 194: @@
 ==write an appropriate matlab function==
-The last step to creating a new object in the framework is to create a <tt>bindings/matlab/classes/@IXTclassname</tt> directory. This directory then needs to be populated with the following files
+The last step to creating a new object in the framework is to create a <tt>bindings/matlab/classes/@IXTclassname</tt> directory. this identifies <tt>IXTclassname</tt> as a class to matlab. Within this directory you create <tt>.m</tt> files corresponding to the functions that operation on the class. these can have any name you wish, but there are two that you must create.
 <tt>
 * IXTclassname.m
 * display.m
-* method.m </tt>(ie. any non-standard object method which is defined in <tt>libisisexc.txt</tt> eg. plus.m)
+</tt>
 <pre>

@@ Line 194: / Line 194: @@
 ==write an appropriate matlab function==
- in <tt>bindings/matlab/classes/@IXTclassname</tt> directory
+The last step to creating a new object in the framework is to create a <tt>bindings/matlab/classes/@IXTclassname</tt> directory. This directory then needs to be populated with the following files
 this function must make a call to the libisisexc DLL

@@ Line 172: / Line 172: @@
 </pre>
-==define object subroutine pair in <tt>bindings/matlab/libisisexc.txt</tt> ==
+==define object method pair in <tt>bindings/matlab/libisisexc.txt</tt> ==
 we need to define all the subroutines which need to be accessed from the matlab front-end in another file, together with the number of input and output arguments. they are defined as a classname/method pair in the <tt>bindings/matlab/libisisexc.txt</tt> file with a general constuction:
 <pre>

@@ Line 173: / Line 173: @@
 ==define object subroutine pair in <tt>bindings/matlab/libisisexc.txt</tt> ==
-we need to define all the subroutines which need to be accessed from the matlab front-end in another file, together with the number of input and output arguments. they are defined as a classname/method pair in the <tt>bindings/matlab/libisisexc.txt file with a general constuction:
+we need to define all the subroutines which need to be accessed from the matlab front-end in another file, together with the number of input and output arguments. they are defined as a classname/method pair in the <tt>bindings/matlab/libisisexc.txt</tt> file with a general constuction:
 <pre>
 IXTclassname     method    no_of_output_args   no_of_input_args

@@ Line 128: / Line 128: @@
 preprocesing can also be used to generate common code in the bindings, for example to create general code for unary operations (log, exp,sin etc...) called from the matlab front-end, there is explanation on preprocessing files [[Libclasses#Preprocessing files|here]]
-in the file <tt>bindings/matlab/IXMdataset_2d_m.f90</tt> the KEYWORDS are set
+in the file <tt>bindings/matlab/IXMdataset_2d_m.f90</tt> the KEYWORDS are defined
 <pre>
 #define IXD_TYPE	dataset_2d
@@ Line 135: / Line 135: @@
 </pre>
-and in the include file <tt>unary_ops.f90</tt> they are substituted
+and in the include file <tt>bindings/matlab/unary_ops.f90</tt> they are substituted
 <pre>
 #if defined(IXD_TYPE) && defined(IXD_NAME)

@@ Line 126: / Line 126: @@
 ===preprocessing operations===
-preprocesing can also be used to generate common code in the bindings
+preprocesing can also be used to generate common code in the bindings, for example to create general code for unary operations (log, exp,sin etc...) called from the matlab front-end, there is explanation on preprocessing files [[Libclasses#Preprocessing files|here]]
 ==define object subroutine pair in <tt>libisisexc.txt</tt> ==

@@ Line 123: / Line 123: @@
    end subroutine IXBplus_testclass
 </pre>
 ==define object subroutine pair in <tt>libisisexc.txt</tt> ==

Matlab Bindings - Revision history

Dickon Champion at 16:27, 16 May 2008

Dickon Champion: /* write an appropriate matlab function */

Dickon Champion: /* write an appropriate matlab function */

Dickon Champion: /* write an appropriate matlab function */

Dickon Champion: /* define object subroutine pair in bindings/matlab/libisisexc.txt */

Dickon Champion: /* define object subroutine pair in bindings/matlab/libisisexc.txt */

Dickon Champion: /* define object subroutine pair in libisisexc.txt */

Dickon Champion: /* preprocessing operations */

Dickon Champion: /* preprocessing operations */

Dickon Champion: /* define an appropriate binding subroutine in IXMclassname_m.f90 */

Dickon Champion: /* define object subroutine pair in `bindings/matlab/libisisexc.txt` */

Dickon Champion: /* define object subroutine pair in `bindings/matlab/libisisexc.txt` */

Dickon Champion: /* define object subroutine pair in `libisisexc.txt` */

Dickon Champion: /* define an appropriate binding subroutine in `IXMclassname_m.f90` */