diff options
Diffstat (limited to 'doc/latex/src_2fun_8h.tex')
| -rw-r--r-- | doc/latex/src_2fun_8h.tex | 55 |
1 files changed, 47 insertions, 8 deletions
diff --git a/doc/latex/src_2fun_8h.tex b/doc/latex/src_2fun_8h.tex index c19bfc3..1428746 100644 --- a/doc/latex/src_2fun_8h.tex +++ b/doc/latex/src_2fun_8h.tex @@ -3,10 +3,12 @@ \doxysubsection*{Classes} \begin{DoxyCompactItemize} \item +struct \mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t}{FUNCSTRUCT}} +\begin{DoxyCompactList}\small\item\em Struct used to pass structs to Octave from the fun library. \end{DoxyCompactList}\item struct \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s}{FUNCARGS}} -\item +\begin{DoxyCompactList}\small\item\em Struct used to send/receive Scilab data to/from the gateway to \mbox{\hyperlink{fun_8cpp}{fun.\+cpp}} API. \end{DoxyCompactList}\item struct \mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}} -\end{DoxyCompactItemize} +\begin{DoxyCompactList}\small\item\em Struct used to call and pass the data to \mbox{\hyperlink{fun_8cpp}{fun.\+cpp}} API. \end{DoxyCompactList}\end{DoxyCompactItemize} \doxysubsection*{Macros} \begin{DoxyCompactItemize} \item @@ -15,17 +17,24 @@ struct \mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}} \doxysubsection*{Enumerations} \begin{DoxyCompactItemize} \item -enum \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}} \{ \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}{TYPE\+\_\+\+DOUBLE}} +enum \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}} \{ \newline +\mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}{TYPE\+\_\+\+DOUBLE}} +, \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc}{TYPE\+\_\+\+COMPLEX}} , \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}{TYPE\+\_\+\+STRING}} -, \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}{TYPE\+\_\+\+DOUBLE}} +, \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c}{TYPE\+\_\+\+STRUCT}} +, \newline +\mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}{TYPE\+\_\+\+DOUBLE}} +, \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc}{TYPE\+\_\+\+COMPLEX}} , \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}{TYPE\+\_\+\+STRING}} +, \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c}{TYPE\+\_\+\+STRUCT}} \} \end{DoxyCompactItemize} \doxysubsection*{Functions} \begin{DoxyCompactItemize} \item int \mbox{\hyperlink{src_2fun_8h_adda0eaf7454844236de53495b494cdd4}{fun}} (\mbox{\hyperlink{struct_f_u_n_c_a_r_g_s}{FUNCARGS}} $\ast$arr, \mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}} $\ast$call) -\begin{DoxyCompactList}\small\item\em Function to Interact with Octave\textquotesingle{}s API. \end{DoxyCompactList}\end{DoxyCompactItemize} +\begin{DoxyCompactList}\small\item\em API Function to call/receive and pass the data to fun API ~\newline + \end{DoxyCompactList}\end{DoxyCompactItemize} \doxysubsection{Macro Definition Documentation} @@ -46,21 +55,37 @@ int \mbox{\hyperlink{src_2fun_8h_adda0eaf7454844236de53495b494cdd4}{fun}} (\mbox \begin{DoxyEnumFields}{Enumerator} \raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_DOUBLE@{TYPE\_DOUBLE}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_DOUBLE@{TYPE\_DOUBLE}}}\mbox{\Hypertarget{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}\label{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}} -TYPE\+\_\+\+DOUBLE&\\ +TYPE\+\_\+\+DOUBLE&similar to scilab double \\ +\hline + +\raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_COMPLEX@{TYPE\_COMPLEX}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_COMPLEX@{TYPE\_COMPLEX}}}\mbox{\Hypertarget{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc}\label{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc}} +TYPE\+\_\+\+COMPLEX&similar to scilab complex \\ \hline \raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_STRING@{TYPE\_STRING}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_STRING@{TYPE\_STRING}}}\mbox{\Hypertarget{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}\label{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}} -TYPE\+\_\+\+STRING&\\ +TYPE\+\_\+\+STRING&similar to scilab string \\ +\hline + +\raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_STRUCT@{TYPE\_STRUCT}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_STRUCT@{TYPE\_STRUCT}}}\mbox{\Hypertarget{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c}\label{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c}} +TYPE\+\_\+\+STRUCT&similar to scilab struct \\ \hline \raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_DOUBLE@{TYPE\_DOUBLE}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_DOUBLE@{TYPE\_DOUBLE}}}\mbox{\Hypertarget{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}\label{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}} TYPE\+\_\+\+DOUBLE&\\ \hline +\raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_COMPLEX@{TYPE\_COMPLEX}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_COMPLEX@{TYPE\_COMPLEX}}}\mbox{\Hypertarget{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc}\label{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc}} +TYPE\+\_\+\+COMPLEX&\\ +\hline + \raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_STRING@{TYPE\_STRING}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_STRING@{TYPE\_STRING}}}\mbox{\Hypertarget{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}\label{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}} TYPE\+\_\+\+STRING&\\ \hline +\raisebox{\heightof{T}}[0pt][0pt]{\index{TYPE\_STRUCT@{TYPE\_STRUCT}!fun.h@{fun.h}}\index{fun.h@{fun.h}!TYPE\_STRUCT@{TYPE\_STRUCT}}}\mbox{\Hypertarget{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c}\label{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c}} +TYPE\+\_\+\+STRUCT&\\ +\hline + \end{DoxyEnumFields} @@ -73,6 +98,20 @@ TYPE\+\_\+\+STRING&\\ -Function to Interact with Octave\textquotesingle{}s API. +API Function to call/receive and pass the data to fun API ~\newline + + + +\begin{DoxyParams}{Parameters} +{\em arr} & Input data \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s}{FUNCARGS}} \\ +\hline +{\em call} & Input Arguments \mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}} \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +int Status Code +\end{DoxyReturn} +API Function to call/receive and pass the data to fun API ~\newline + This Function will be communicating with Octave to access it\textquotesingle{}s function.
\ No newline at end of file |