diff options
Diffstat (limited to 'doc/latex/struct_f_u_n_c_a_r_g_s.tex')
| -rw-r--r-- | doc/latex/struct_f_u_n_c_a_r_g_s.tex | 79 |
1 files changed, 68 insertions, 11 deletions
diff --git a/doc/latex/struct_f_u_n_c_a_r_g_s.tex b/doc/latex/struct_f_u_n_c_a_r_g_s.tex index 517defa..248f71a 100644 --- a/doc/latex/struct_f_u_n_c_a_r_g_s.tex +++ b/doc/latex/struct_f_u_n_c_a_r_g_s.tex @@ -2,6 +2,11 @@ \label{struct_f_u_n_c_a_r_g_s}\index{FUNCARGS@{FUNCARGS}} +Struct used to send/receive Scilab data to/from the gateway to \mbox{\hyperlink{fun_8cpp}{fun.\+cpp}} API. + + + + {\ttfamily \#include $<$fun.\+h$>$} \doxysubsection*{Public Attributes} @@ -13,14 +18,22 @@ int \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a5072b853699aed6ed5cff33a6e48b71d}{n \item int \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a57dd8f6ba533785f3c654289054a9d37}{n\+\_\+in\+\_\+cols}} \item +int \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a3f38c9b21450c6842913df42db54ae4d}{n\+\_\+in\+\_\+struct\+\_\+len}} +\item int \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_accf1038c5390a90bd8465916452918cc}{n\+\_\+out\+\_\+rows}} \item int \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a07cd1a0775fad3da2e3a6d3cb941d3e9}{n\+\_\+out\+\_\+cols}} \item +int \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a418164a53b8efbfe39439fd7ebe52172}{n\+\_\+out\+\_\+struct\+\_\+len}} +\item int \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a6993c7529d472e393bf6d8b62eee4eb9}{is\+\_\+in\+\_\+cmplx}} \item int \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a25918ade41c7afafb4a851e6845ac554}{is\+\_\+out\+\_\+cmplx}} \item +int \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a23897aefce90b1a055e408ef209daab6}{is\+\_\+out\+\_\+struct}} +\item +int \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a5e7fbc7ebf438985fcc91b800a67240e}{is\+\_\+out\+\_\+string}} +\item void $\ast$ \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_afb520ee91cd773811ae5223113c8a82d}{in\+\_\+data\+\_\+real}} \item void $\ast$ \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_aeea2f16c973c70f31ac07d234d509161}{in\+\_\+data\+\_\+img}} @@ -28,9 +41,16 @@ void $\ast$ \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_aeea2f16c973c70f31ac07d234d5 void $\ast$ \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a1ab002ae3f19574b5d7e0469187501f4}{out\+\_\+data\+\_\+real}} \item void $\ast$ \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a057c2aa9db10a409e7b9da3b5f0f17f2}{out\+\_\+data\+\_\+img}} +\item +\mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t}{FUNCSTRUCT}} $\ast$ \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_aabfc4b5433234d1272a8db4a1531ba79}{in\+\_\+struct}} +\item +\mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t}{FUNCSTRUCT}} $\ast$ \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_abb34bfaef96a2e29c65591046c504754}{out\+\_\+struct}} \end{DoxyCompactItemize} +\doxysubsection{Detailed Description} +Struct used to send/receive Scilab data to/from the gateway to \mbox{\hyperlink{fun_8cpp}{fun.\+cpp}} API. + \doxysubsection{Member Data Documentation} \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_aeea2f16c973c70f31ac07d234d509161}\label{struct_f_u_n_c_a_r_g_s_aeea2f16c973c70f31ac07d234d509161}} \index{FUNCARGS@{FUNCARGS}!in\_data\_img@{in\_data\_img}} @@ -38,67 +58,104 @@ void $\ast$ \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s_a057c2aa9db10a409e7b9da3b5f0 \doxysubsubsection{\texorpdfstring{in\_data\_img}{in\_data\_img}} {\footnotesize\ttfamily void $\ast$ FUNCARGS\+::in\+\_\+data\+\_\+img} -\mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_afb520ee91cd773811ae5223113c8a82d}\label{struct_f_u_n_c_a_r_g_s_afb520ee91cd773811ae5223113c8a82d}} +Input imaginary part (complex) array \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_afb520ee91cd773811ae5223113c8a82d}\label{struct_f_u_n_c_a_r_g_s_afb520ee91cd773811ae5223113c8a82d}} \index{FUNCARGS@{FUNCARGS}!in\_data\_real@{in\_data\_real}} \index{in\_data\_real@{in\_data\_real}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{in\_data\_real}{in\_data\_real}} {\footnotesize\ttfamily void $\ast$ FUNCARGS\+::in\+\_\+data\+\_\+real} -\mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a6993c7529d472e393bf6d8b62eee4eb9}\label{struct_f_u_n_c_a_r_g_s_a6993c7529d472e393bf6d8b62eee4eb9}} +Input real part (complex) array \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_aabfc4b5433234d1272a8db4a1531ba79}\label{struct_f_u_n_c_a_r_g_s_aabfc4b5433234d1272a8db4a1531ba79}} +\index{FUNCARGS@{FUNCARGS}!in\_struct@{in\_struct}} +\index{in\_struct@{in\_struct}!FUNCARGS@{FUNCARGS}} +\doxysubsubsection{\texorpdfstring{in\_struct}{in\_struct}} +{\footnotesize\ttfamily \mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t}{FUNCSTRUCT}} $\ast$ FUNCARGS\+::in\+\_\+struct} + +Input struct \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a6993c7529d472e393bf6d8b62eee4eb9}\label{struct_f_u_n_c_a_r_g_s_a6993c7529d472e393bf6d8b62eee4eb9}} \index{FUNCARGS@{FUNCARGS}!is\_in\_cmplx@{is\_in\_cmplx}} \index{is\_in\_cmplx@{is\_in\_cmplx}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{is\_in\_cmplx}{is\_in\_cmplx}} {\footnotesize\ttfamily int FUNCARGS\+::is\+\_\+in\+\_\+cmplx} -\mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a25918ade41c7afafb4a851e6845ac554}\label{struct_f_u_n_c_a_r_g_s_a25918ade41c7afafb4a851e6845ac554}} +Input is a Complex data type \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a25918ade41c7afafb4a851e6845ac554}\label{struct_f_u_n_c_a_r_g_s_a25918ade41c7afafb4a851e6845ac554}} \index{FUNCARGS@{FUNCARGS}!is\_out\_cmplx@{is\_out\_cmplx}} \index{is\_out\_cmplx@{is\_out\_cmplx}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{is\_out\_cmplx}{is\_out\_cmplx}} {\footnotesize\ttfamily int FUNCARGS\+::is\+\_\+out\+\_\+cmplx} -\mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a57dd8f6ba533785f3c654289054a9d37}\label{struct_f_u_n_c_a_r_g_s_a57dd8f6ba533785f3c654289054a9d37}} +Output is a Complex data type \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a5e7fbc7ebf438985fcc91b800a67240e}\label{struct_f_u_n_c_a_r_g_s_a5e7fbc7ebf438985fcc91b800a67240e}} +\index{FUNCARGS@{FUNCARGS}!is\_out\_string@{is\_out\_string}} +\index{is\_out\_string@{is\_out\_string}!FUNCARGS@{FUNCARGS}} +\doxysubsubsection{\texorpdfstring{is\_out\_string}{is\_out\_string}} +{\footnotesize\ttfamily int FUNCARGS\+::is\+\_\+out\+\_\+string} + +Output is a String data type \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a23897aefce90b1a055e408ef209daab6}\label{struct_f_u_n_c_a_r_g_s_a23897aefce90b1a055e408ef209daab6}} +\index{FUNCARGS@{FUNCARGS}!is\_out\_struct@{is\_out\_struct}} +\index{is\_out\_struct@{is\_out\_struct}!FUNCARGS@{FUNCARGS}} +\doxysubsubsection{\texorpdfstring{is\_out\_struct}{is\_out\_struct}} +{\footnotesize\ttfamily int FUNCARGS\+::is\+\_\+out\+\_\+struct} + +Output is a Struct data type \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a57dd8f6ba533785f3c654289054a9d37}\label{struct_f_u_n_c_a_r_g_s_a57dd8f6ba533785f3c654289054a9d37}} \index{FUNCARGS@{FUNCARGS}!n\_in\_cols@{n\_in\_cols}} \index{n\_in\_cols@{n\_in\_cols}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{n\_in\_cols}{n\_in\_cols}} {\footnotesize\ttfamily int FUNCARGS\+::n\+\_\+in\+\_\+cols} -\mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a5072b853699aed6ed5cff33a6e48b71d}\label{struct_f_u_n_c_a_r_g_s_a5072b853699aed6ed5cff33a6e48b71d}} +Input cols dimension of data \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a5072b853699aed6ed5cff33a6e48b71d}\label{struct_f_u_n_c_a_r_g_s_a5072b853699aed6ed5cff33a6e48b71d}} \index{FUNCARGS@{FUNCARGS}!n\_in\_rows@{n\_in\_rows}} \index{n\_in\_rows@{n\_in\_rows}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{n\_in\_rows}{n\_in\_rows}} {\footnotesize\ttfamily int FUNCARGS\+::n\+\_\+in\+\_\+rows} -\mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a07cd1a0775fad3da2e3a6d3cb941d3e9}\label{struct_f_u_n_c_a_r_g_s_a07cd1a0775fad3da2e3a6d3cb941d3e9}} +Input rows dimension of data \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a3f38c9b21450c6842913df42db54ae4d}\label{struct_f_u_n_c_a_r_g_s_a3f38c9b21450c6842913df42db54ae4d}} +\index{FUNCARGS@{FUNCARGS}!n\_in\_struct\_len@{n\_in\_struct\_len}} +\index{n\_in\_struct\_len@{n\_in\_struct\_len}!FUNCARGS@{FUNCARGS}} +\doxysubsubsection{\texorpdfstring{n\_in\_struct\_len}{n\_in\_struct\_len}} +{\footnotesize\ttfamily int FUNCARGS\+::n\+\_\+in\+\_\+struct\+\_\+len} + +input struct length \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a07cd1a0775fad3da2e3a6d3cb941d3e9}\label{struct_f_u_n_c_a_r_g_s_a07cd1a0775fad3da2e3a6d3cb941d3e9}} \index{FUNCARGS@{FUNCARGS}!n\_out\_cols@{n\_out\_cols}} \index{n\_out\_cols@{n\_out\_cols}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{n\_out\_cols}{n\_out\_cols}} {\footnotesize\ttfamily int FUNCARGS\+::n\+\_\+out\+\_\+cols} -\mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_accf1038c5390a90bd8465916452918cc}\label{struct_f_u_n_c_a_r_g_s_accf1038c5390a90bd8465916452918cc}} +Output cols dimension of data \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_accf1038c5390a90bd8465916452918cc}\label{struct_f_u_n_c_a_r_g_s_accf1038c5390a90bd8465916452918cc}} \index{FUNCARGS@{FUNCARGS}!n\_out\_rows@{n\_out\_rows}} \index{n\_out\_rows@{n\_out\_rows}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{n\_out\_rows}{n\_out\_rows}} {\footnotesize\ttfamily int FUNCARGS\+::n\+\_\+out\+\_\+rows} -\mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a057c2aa9db10a409e7b9da3b5f0f17f2}\label{struct_f_u_n_c_a_r_g_s_a057c2aa9db10a409e7b9da3b5f0f17f2}} +Ouput rows dimension of data \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a418164a53b8efbfe39439fd7ebe52172}\label{struct_f_u_n_c_a_r_g_s_a418164a53b8efbfe39439fd7ebe52172}} +\index{FUNCARGS@{FUNCARGS}!n\_out\_struct\_len@{n\_out\_struct\_len}} +\index{n\_out\_struct\_len@{n\_out\_struct\_len}!FUNCARGS@{FUNCARGS}} +\doxysubsubsection{\texorpdfstring{n\_out\_struct\_len}{n\_out\_struct\_len}} +{\footnotesize\ttfamily int FUNCARGS\+::n\+\_\+out\+\_\+struct\+\_\+len} + +Output struct length \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a057c2aa9db10a409e7b9da3b5f0f17f2}\label{struct_f_u_n_c_a_r_g_s_a057c2aa9db10a409e7b9da3b5f0f17f2}} \index{FUNCARGS@{FUNCARGS}!out\_data\_img@{out\_data\_img}} \index{out\_data\_img@{out\_data\_img}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{out\_data\_img}{out\_data\_img}} {\footnotesize\ttfamily void $\ast$ FUNCARGS\+::out\+\_\+data\+\_\+img} -\mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a1ab002ae3f19574b5d7e0469187501f4}\label{struct_f_u_n_c_a_r_g_s_a1ab002ae3f19574b5d7e0469187501f4}} +Output imaginary part (complex) array \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a1ab002ae3f19574b5d7e0469187501f4}\label{struct_f_u_n_c_a_r_g_s_a1ab002ae3f19574b5d7e0469187501f4}} \index{FUNCARGS@{FUNCARGS}!out\_data\_real@{out\_data\_real}} \index{out\_data\_real@{out\_data\_real}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{out\_data\_real}{out\_data\_real}} {\footnotesize\ttfamily void $\ast$ FUNCARGS\+::out\+\_\+data\+\_\+real} -\mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a580ae591432835016133e2ada44be2c9}\label{struct_f_u_n_c_a_r_g_s_a580ae591432835016133e2ada44be2c9}} +Output real part (complex) array \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_abb34bfaef96a2e29c65591046c504754}\label{struct_f_u_n_c_a_r_g_s_abb34bfaef96a2e29c65591046c504754}} +\index{FUNCARGS@{FUNCARGS}!out\_struct@{out\_struct}} +\index{out\_struct@{out\_struct}!FUNCARGS@{FUNCARGS}} +\doxysubsubsection{\texorpdfstring{out\_struct}{out\_struct}} +{\footnotesize\ttfamily \mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t}{FUNCSTRUCT}} $\ast$ FUNCARGS\+::out\+\_\+struct} + +Output struct \mbox{\Hypertarget{struct_f_u_n_c_a_r_g_s_a580ae591432835016133e2ada44be2c9}\label{struct_f_u_n_c_a_r_g_s_a580ae591432835016133e2ada44be2c9}} \index{FUNCARGS@{FUNCARGS}!type@{type}} \index{type@{type}!FUNCARGS@{FUNCARGS}} \doxysubsubsection{\texorpdfstring{type}{type}} {\footnotesize\ttfamily \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}} FUNCARGS\+::type} - +Type of data ~\newline + The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} \item |