From 96edee02e6414bf26b21420405cfc299f85683d3 Mon Sep 17 00:00:00 2001 From: KRIXUS-alpha Date: Wed, 12 May 2021 20:15:09 +0530 Subject: documentation struct data handling --- doc/html/src_2fun_8h.html | 44 ++++++++++++++++++++++++++++++++++++++------ 1 file changed, 38 insertions(+), 6 deletions(-) (limited to 'doc/html/src_2fun_8h.html') diff --git a/doc/html/src_2fun_8h.html b/doc/html/src_2fun_8h.html index 0620784..81b1511 100644 --- a/doc/html/src_2fun_8h.html +++ b/doc/html/src_2fun_8h.html @@ -107,9 +107,14 @@ $(document).ready(function(){initNavTree('src_2fun_8h.html',''); initResizable() + + + + +

Classes

struct  FUNCSTRUCT
 Struct used to pass structs to Octave from the fun library. More...
 
struct  FUNCARGS
 Struct used to send/receive Scilab data to/from the gateway to fun.cpp API. More...
 
struct  FUNCCALL
 Struct used to call and pass the data to fun.cpp API. More...
 

@@ -119,17 +124,25 @@ Macros

-

Enumerations

enum  FUNCTYPE { TYPE_DOUBLE +
enum  FUNCTYPE {
+  TYPE_DOUBLE +, TYPE_COMPLEX , TYPE_STRING -, TYPE_DOUBLE +, TYPE_STRUCT +,
+  TYPE_DOUBLE +, TYPE_COMPLEX , TYPE_STRING +, TYPE_STRUCT +
}
 
- +

Functions

int fun (FUNCARGS *arr, FUNCCALL *call)
 Function to Interact with Octave's API. More...
 API Function to call/receive and pass the data to fun API
+ More...
 

Macro Definition Documentation

@@ -160,10 +173,18 @@ Functions
- - + + + + + +
Enumerator
TYPE_DOUBLE 
TYPE_STRING 
Enumerator
TYPE_DOUBLE 

similar to scilab double

+
TYPE_COMPLEX 

similar to scilab complex

+
TYPE_STRING 

similar to scilab string

+
TYPE_STRUCT 

similar to scilab struct

+
TYPE_DOUBLE 
TYPE_COMPLEX 
TYPE_STRING 
TYPE_STRUCT 
@@ -195,7 +216,18 @@ Functions
-

Function to Interact with Octave's API.

+

API Function to call/receive and pass the data to fun API
+

+
Parameters
+ + + +
arrInput data FUNCARGS
callInput Arguments FUNCCALL
+
+
+
Returns
int Status Code
+

API Function to call/receive and pass the data to fun API
+

This Function will be communicating with Octave to access it's function.

-- cgit From 884558103568b38503b5010253cdd9d02d001c70 Mon Sep 17 00:00:00 2001 From: KRIXUS-alpha Date: Wed, 12 May 2021 20:24:32 +0530 Subject: Updated Documentation Struct data handling --- doc/html/src_2fun_8h.html | 3 +++ 1 file changed, 3 insertions(+) (limited to 'doc/html/src_2fun_8h.html') diff --git a/doc/html/src_2fun_8h.html b/doc/html/src_2fun_8h.html index 81b1511..241daa6 100644 --- a/doc/html/src_2fun_8h.html +++ b/doc/html/src_2fun_8h.html @@ -136,6 +136,7 @@ Enumerations , TYPE_STRUCT
} + Enumeration for the data types suported. More...
 

@@ -172,6 +173,8 @@ Functions

+ +

Enumeration for the data types suported.

-- cgit
Enumerator
TYPE_DOUBLE 

similar to scilab double