summaryrefslogtreecommitdiff
path: root/doc/html/src_2fun_8h.html
diff options
context:
space:
mode:
authorRupak Rokade2021-07-04 18:18:49 +0530
committerGitHub2021-07-04 18:18:49 +0530
commit0dde2f4241572e7ab07b6e6f9095b071449f6c0f (patch)
tree243b8841f0b787f2096ccc6c0a0a8a95cd99a331 /doc/html/src_2fun_8h.html
parent66ab875f7a0de3acaa0c9e2b1a8eb4ebee5f2481 (diff)
parent0b968ae5124a37916f9ab901e91a11cd90ff81a4 (diff)
downloadfossee-scilab-octave-toolbox-master.tar.gz
fossee-scilab-octave-toolbox-master.tar.bz2
fossee-scilab-octave-toolbox-master.zip
Merge pull request #7 from Detailer/masterHEADmaster
Added Support for Windows OS
Diffstat (limited to 'doc/html/src_2fun_8h.html')
-rw-r--r--doc/html/src_2fun_8h.html47
1 files changed, 41 insertions, 6 deletions
diff --git a/doc/html/src_2fun_8h.html b/doc/html/src_2fun_8h.html
index 0620784..241daa6 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()
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_f_u_n_c_s_t_r_u_c_t.html">FUNCSTRUCT</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct used to pass structs to Octave from the fun library. <a href="struct_f_u_n_c_s_t_r_u_c_t.html#details">More...</a><br /></td></tr>
+<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_f_u_n_c_a_r_g_s.html">FUNCARGS</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct used to send/receive Scilab data to/from the gateway to <a class="el" href="fun_8cpp.html">fun.cpp</a> API. <a href="struct_f_u_n_c_a_r_g_s.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_f_u_n_c_c_a_l_l.html">FUNCCALL</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Struct used to call and pass the data to <a class="el" href="fun_8cpp.html">fun.cpp</a> API. <a href="struct_f_u_n_c_c_a_l_l.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
@@ -119,17 +124,26 @@ Macros</h2></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
-<tr class="memitem:a160793ea95e0b5106580229a2a5f1134"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134">FUNCTYPE</a> { <a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c">TYPE_DOUBLE</a>
+<tr class="memitem:a160793ea95e0b5106580229a2a5f1134"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134">FUNCTYPE</a> { <br />
+&#160;&#160;<a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c">TYPE_DOUBLE</a>
+, <a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc">TYPE_COMPLEX</a>
, <a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a">TYPE_STRING</a>
-, <a class="el" href="thirdparty_2linux_2include_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c">TYPE_DOUBLE</a>
+, <a class="el" href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c">TYPE_STRUCT</a>
+, <br />
+&#160;&#160;<a class="el" href="thirdparty_2linux_2include_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c">TYPE_DOUBLE</a>
+, <a class="el" href="thirdparty_2linux_2include_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc">TYPE_COMPLEX</a>
, <a class="el" href="thirdparty_2linux_2include_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a">TYPE_STRING</a>
+, <a class="el" href="thirdparty_2linux_2include_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c">TYPE_STRUCT</a>
+<br />
}</td></tr>
+<tr class="memdesc:a160793ea95e0b5106580229a2a5f1134"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration for the data types suported. <a href="src_2fun_8h.html#a160793ea95e0b5106580229a2a5f1134">More...</a><br /></td></tr>
<tr class="separator:a160793ea95e0b5106580229a2a5f1134"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:adda0eaf7454844236de53495b494cdd4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="src_2fun_8h.html#adda0eaf7454844236de53495b494cdd4">fun</a> (<a class="el" href="struct_f_u_n_c_a_r_g_s.html">FUNCARGS</a> *arr, <a class="el" href="struct_f_u_n_c_c_a_l_l.html">FUNCCALL</a> *call)</td></tr>
-<tr class="memdesc:adda0eaf7454844236de53495b494cdd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Function to Interact with Octave's API. <a href="src_2fun_8h.html#adda0eaf7454844236de53495b494cdd4">More...</a><br /></td></tr>
+<tr class="memdesc:adda0eaf7454844236de53495b494cdd4"><td class="mdescLeft">&#160;</td><td class="mdescRight">API Function to call/receive and pass the data to fun API <br />
+ <a href="src_2fun_8h.html#adda0eaf7454844236de53495b494cdd4">More...</a><br /></td></tr>
<tr class="separator:adda0eaf7454844236de53495b494cdd4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
@@ -159,11 +173,21 @@ Functions</h2></td></tr>
</tr>
</table>
</div><div class="memdoc">
+
+<p>Enumeration for the data types suported. </p>
<table class="fieldtable">
-<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c"></a>TYPE_DOUBLE&#160;</td><td class="fielddoc"></td></tr>
-<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a"></a>TYPE_STRING&#160;</td><td class="fielddoc"></td></tr>
+<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c"></a>TYPE_DOUBLE&#160;</td><td class="fielddoc"><p>similar to scilab double </p>
+</td></tr>
+<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc"></a>TYPE_COMPLEX&#160;</td><td class="fielddoc"><p>similar to scilab complex </p>
+</td></tr>
+<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a"></a>TYPE_STRING&#160;</td><td class="fielddoc"><p>similar to scilab string </p>
+</td></tr>
+<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c"></a>TYPE_STRUCT&#160;</td><td class="fielddoc"><p>similar to scilab struct </p>
+</td></tr>
<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c"></a>TYPE_DOUBLE&#160;</td><td class="fielddoc"></td></tr>
+<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc"></a>TYPE_COMPLEX&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a"></a>TYPE_STRING&#160;</td><td class="fielddoc"></td></tr>
+<tr><td class="fieldname"><a id="a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c"></a>TYPE_STRUCT&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
@@ -195,7 +219,18 @@ Functions</h2></td></tr>
</table>
</div><div class="memdoc">
-<p>Function to Interact with Octave's API. </p>
+<p>API Function to call/receive and pass the data to fun API <br />
+ </p>
+<dl class="params"><dt>Parameters</dt><dd>
+ <table class="params">
+ <tr><td class="paramname">arr</td><td>Input data <a class="el" href="struct_f_u_n_c_a_r_g_s.html" title="Struct used to send/receive Scilab data to/from the gateway to fun.cpp API.">FUNCARGS</a> </td></tr>
+ <tr><td class="paramname">call</td><td>Input Arguments <a class="el" href="struct_f_u_n_c_c_a_l_l.html" title="Struct used to call and pass the data to fun.cpp API.">FUNCCALL</a> </td></tr>
+ </table>
+ </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>int Status Code</dd></dl>
+<p>API Function to call/receive and pass the data to fun API <br />
+</p>
<p>This Function will be communicating with Octave to access it's function. </p>
</div>