diff options
Diffstat (limited to 'doc/latex')
| -rw-r--r-- | doc/latex/annotated.tex | 5 | ||||
| -rw-r--r-- | doc/latex/fun_8cpp.tex | 4 | ||||
| -rw-r--r-- | doc/latex/refman.tex | 1 | ||||
| -rw-r--r-- | doc/latex/sci__octave_8cpp.tex | 23 | ||||
| -rw-r--r-- | doc/latex/src_2fun_8h.tex | 61 | ||||
| -rw-r--r-- | doc/latex/struct_f_u_n_c_a_r_g_s.tex | 79 | ||||
| -rw-r--r-- | doc/latex/struct_f_u_n_c_c_a_l_l.tex | 18 | ||||
| -rw-r--r-- | doc/latex/struct_f_u_n_c_s_t_r_u_c_t.tex | 81 | ||||
| -rw-r--r-- | doc/latex/thirdparty_2linux_2include_2fun_8h.tex | 39 |
9 files changed, 277 insertions, 34 deletions
diff --git a/doc/latex/annotated.tex b/doc/latex/annotated.tex index ba5e301..16693c6 100644 --- a/doc/latex/annotated.tex +++ b/doc/latex/annotated.tex @@ -1,5 +1,6 @@ \doxysection{Class List} Here are the classes, structs, unions and interfaces with brief descriptions\+:\begin{DoxyCompactList} -\item\contentsline{section}{\mbox{\hyperlink{struct_f_u_n_c_a_r_g_s}{FUNCARGS}} }{\pageref{struct_f_u_n_c_a_r_g_s}}{} -\item\contentsline{section}{\mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}} }{\pageref{struct_f_u_n_c_c_a_l_l}}{} +\item\contentsline{section}{\mbox{\hyperlink{struct_f_u_n_c_a_r_g_s}{FUNCARGS}} \\*Struct used to send/receive Scilab data to/from the gateway to \mbox{\hyperlink{fun_8cpp}{fun.\+cpp}} API }{\pageref{struct_f_u_n_c_a_r_g_s}}{} +\item\contentsline{section}{\mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}} \\*Struct used to call and pass the data to \mbox{\hyperlink{fun_8cpp}{fun.\+cpp}} API }{\pageref{struct_f_u_n_c_c_a_l_l}}{} +\item\contentsline{section}{\mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t}{FUNCSTRUCT}} \\*Struct used to pass structs to Octave from the fun library }{\pageref{struct_f_u_n_c_s_t_r_u_c_t}}{} \end{DoxyCompactList} diff --git a/doc/latex/fun_8cpp.tex b/doc/latex/fun_8cpp.tex index 4f6a057..1650584 100644 --- a/doc/latex/fun_8cpp.tex +++ b/doc/latex/fun_8cpp.tex @@ -8,6 +8,7 @@ {\ttfamily \#include $<$octave/interpreter.\+h$>$}\newline {\ttfamily \#include $<$math.\+h$>$}\newline {\ttfamily \#include $<$string$>$}\newline +{\ttfamily \#include $<$cstring$>$}\newline {\ttfamily \#include \char`\"{}fun.\+h\char`\"{}}\newline \doxysubsection*{Functions} \begin{DoxyCompactItemize} @@ -27,4 +28,7 @@ int \mbox{\hyperlink{fun_8cpp_ab2457155d6e8298bdfd7bae4ffd01f80}{fun}} (\mbox{\h Function to Interact with Octave\textquotesingle{}s API. +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 diff --git a/doc/latex/refman.tex b/doc/latex/refman.tex index d5731f1..2bd6cf6 100644 --- a/doc/latex/refman.tex +++ b/doc/latex/refman.tex @@ -182,6 +182,7 @@ \chapter{Class Documentation} \input{struct_f_u_n_c_a_r_g_s} \input{struct_f_u_n_c_c_a_l_l} +\input{struct_f_u_n_c_s_t_r_u_c_t} \chapter{File Documentation} \input{_r_e_a_d_m_e_8md} \input{libscilab__octave_8cpp} diff --git a/doc/latex/sci__octave_8cpp.tex b/doc/latex/sci__octave_8cpp.tex index 308e881..5c9a2d3 100644 --- a/doc/latex/sci__octave_8cpp.tex +++ b/doc/latex/sci__octave_8cpp.tex @@ -33,4 +33,25 @@ int \mbox{\hyperlink{sci__octave_8cpp_a74f2258789a64de6417c6d8912144449}{sci\+\_ Function to connect to Scilab\textquotesingle{}s API. -This function will get Data from Scilab, proccess the data in Octave then return the output back to Scilab using the API.
\ No newline at end of file +This function will get Data from Scilab, proccess the data in Octave then return the output back to Scilab using the API. + + +\begin{DoxyParams}{Parameters} +{\em env} & Scialb env \\ +\hline +{\em nin\mbox{[}in\mbox{]}} & Number of input arguments \\ +\hline +{\em in\mbox{[}in\mbox{]}} & Input Parameters \\ +\hline +{\em nopt\mbox{[}in\mbox{]}} & Number of optional parameters \\ +\hline +{\em opt\mbox{[}in\mbox{]}} & Optional parameters \\ +\hline +{\em nout\mbox{[}out\mbox{]}} & Number of expected output parametets \\ +\hline +{\em out\mbox{[}out\mbox{]}} & Array for output data \\ +\hline +\end{DoxyParams} +\begin{DoxyReturn}{Returns} +int +\end{DoxyReturn} diff --git a/doc/latex/src_2fun_8h.tex b/doc/latex/src_2fun_8h.tex index c19bfc3..af0ba56 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} +\begin{DoxyCompactList}\small\item\em Enumeration for the data types suported. \end{DoxyCompactList}\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} @@ -44,23 +53,43 @@ int \mbox{\hyperlink{src_2fun_8h_adda0eaf7454844236de53495b494cdd4}{fun}} (\mbox \doxysubsubsection{\texorpdfstring{FUNCTYPE}{FUNCTYPE}} {\footnotesize\ttfamily enum \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}}} + + +Enumeration for the data types suported. + \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 +102,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 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 diff --git a/doc/latex/struct_f_u_n_c_c_a_l_l.tex b/doc/latex/struct_f_u_n_c_c_a_l_l.tex index 672393e..777013d 100644 --- a/doc/latex/struct_f_u_n_c_c_a_l_l.tex +++ b/doc/latex/struct_f_u_n_c_c_a_l_l.tex @@ -2,6 +2,11 @@ \label{struct_f_u_n_c_c_a_l_l}\index{FUNCCALL@{FUNCCALL}} +Struct used to call and pass the data to \mbox{\hyperlink{fun_8cpp}{fun.\+cpp}} API. + + + + {\ttfamily \#include $<$fun.\+h$>$} \doxysubsection*{Public Attributes} @@ -19,6 +24,9 @@ char $\ast$ \mbox{\hyperlink{struct_f_u_n_c_c_a_l_l_afbac69a2aa8ae198e46614a2e12 \end{DoxyCompactItemize} +\doxysubsection{Detailed Description} +Struct used to call and pass the data to \mbox{\hyperlink{fun_8cpp}{fun.\+cpp}} API. + \doxysubsection{Member Data Documentation} \mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_a6ae4ef88bdc4be97e5363448f9522beb}\label{struct_f_u_n_c_c_a_l_l_a6ae4ef88bdc4be97e5363448f9522beb}} \index{FUNCCALL@{FUNCCALL}!argument@{argument}} @@ -26,31 +34,31 @@ char $\ast$ \mbox{\hyperlink{struct_f_u_n_c_c_a_l_l_afbac69a2aa8ae198e46614a2e12 \doxysubsubsection{\texorpdfstring{argument}{argument}} {\footnotesize\ttfamily \mbox{\hyperlink{struct_f_u_n_c_a_r_g_s}{FUNCARGS}} $\ast$ FUNCCALL\+::argument} -\mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_afbac69a2aa8ae198e46614a2e1228a56}\label{struct_f_u_n_c_c_a_l_l_afbac69a2aa8ae198e46614a2e1228a56}} +Struct defining and containing the data \mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_afbac69a2aa8ae198e46614a2e1228a56}\label{struct_f_u_n_c_c_a_l_l_afbac69a2aa8ae198e46614a2e1228a56}} \index{FUNCCALL@{FUNCCALL}!err@{err}} \index{err@{err}!FUNCCALL@{FUNCCALL}} \doxysubsubsection{\texorpdfstring{err}{err}} {\footnotesize\ttfamily char $\ast$ FUNCCALL\+::err} -\mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_a15b282cd4eb7e33fe14aaea926b1a98a}\label{struct_f_u_n_c_c_a_l_l_a15b282cd4eb7e33fe14aaea926b1a98a}} +Return errors \mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_a15b282cd4eb7e33fe14aaea926b1a98a}\label{struct_f_u_n_c_c_a_l_l_a15b282cd4eb7e33fe14aaea926b1a98a}} \index{FUNCCALL@{FUNCCALL}!n\_in\_arguments@{n\_in\_arguments}} \index{n\_in\_arguments@{n\_in\_arguments}!FUNCCALL@{FUNCCALL}} \doxysubsubsection{\texorpdfstring{n\_in\_arguments}{n\_in\_arguments}} {\footnotesize\ttfamily int FUNCCALL\+::n\+\_\+in\+\_\+arguments} -\mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_a4c3ce57d43862cda7780e020e6ce2349}\label{struct_f_u_n_c_c_a_l_l_a4c3ce57d43862cda7780e020e6ce2349}} +Number of input arguments \mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_a4c3ce57d43862cda7780e020e6ce2349}\label{struct_f_u_n_c_c_a_l_l_a4c3ce57d43862cda7780e020e6ce2349}} \index{FUNCCALL@{FUNCCALL}!n\_out\_arguments@{n\_out\_arguments}} \index{n\_out\_arguments@{n\_out\_arguments}!FUNCCALL@{FUNCCALL}} \doxysubsubsection{\texorpdfstring{n\_out\_arguments}{n\_out\_arguments}} {\footnotesize\ttfamily int FUNCCALL\+::n\+\_\+out\+\_\+arguments} -\mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_a964c4a02c04884e73bd261aa10180d4e}\label{struct_f_u_n_c_c_a_l_l_a964c4a02c04884e73bd261aa10180d4e}} +Number of output arguements in Scilab \mbox{\Hypertarget{struct_f_u_n_c_c_a_l_l_a964c4a02c04884e73bd261aa10180d4e}\label{struct_f_u_n_c_c_a_l_l_a964c4a02c04884e73bd261aa10180d4e}} \index{FUNCCALL@{FUNCCALL}!n\_out\_user@{n\_out\_user}} \index{n\_out\_user@{n\_out\_user}!FUNCCALL@{FUNCCALL}} \doxysubsubsection{\texorpdfstring{n\_out\_user}{n\_out\_user}} {\footnotesize\ttfamily int FUNCCALL\+::n\+\_\+out\+\_\+user} - +Number of output arguements expected to be returned from Octave The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} \item diff --git a/doc/latex/struct_f_u_n_c_s_t_r_u_c_t.tex b/doc/latex/struct_f_u_n_c_s_t_r_u_c_t.tex new file mode 100644 index 0000000..44f4c2f --- /dev/null +++ b/doc/latex/struct_f_u_n_c_s_t_r_u_c_t.tex @@ -0,0 +1,81 @@ +\hypertarget{struct_f_u_n_c_s_t_r_u_c_t}{}\doxysection{FUNCSTRUCT Struct Reference} +\label{struct_f_u_n_c_s_t_r_u_c_t}\index{FUNCSTRUCT@{FUNCSTRUCT}} + + +Struct used to pass structs to Octave from the fun library. + + + + +{\ttfamily \#include $<$fun.\+h$>$} + +\doxysubsection*{Public Attributes} +\begin{DoxyCompactItemize} +\item +\mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}} \mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t_a03c3251e6292eeca88505406761e4fd7}{type}} +\item +void $\ast$ \mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t_ae298630243ee8fadf8503dd4fd81f52b}{key}} +\item +int \mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t_a7512f24fd057d4d93074e9a5c7951157}{rows}} +\item +int \mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t_ad40fd4328e821e9eaa553bbdf5c83bba}{cols}} +\item +void $\ast$ \mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t_a91ce1300dd1b9c3b18ac38c34171d679}{data\+Real}} +\item +void $\ast$ \mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t_ae7fbe0037ac898a607fe3648afa61be2}{data\+Img}} +\item +void $\ast$ \mbox{\hyperlink{struct_f_u_n_c_s_t_r_u_c_t_a175d20292e70fd1fb89e40d6d128653d}{str}} +\end{DoxyCompactItemize} + + +\doxysubsection{Detailed Description} +Struct used to pass structs to Octave from the fun library. + +\doxysubsection{Member Data Documentation} +\mbox{\Hypertarget{struct_f_u_n_c_s_t_r_u_c_t_ad40fd4328e821e9eaa553bbdf5c83bba}\label{struct_f_u_n_c_s_t_r_u_c_t_ad40fd4328e821e9eaa553bbdf5c83bba}} +\index{FUNCSTRUCT@{FUNCSTRUCT}!cols@{cols}} +\index{cols@{cols}!FUNCSTRUCT@{FUNCSTRUCT}} +\doxysubsubsection{\texorpdfstring{cols}{cols}} +{\footnotesize\ttfamily int FUNCSTRUCT\+::cols} + +cols dimension of struct fields\textquotesingle{} value \mbox{\Hypertarget{struct_f_u_n_c_s_t_r_u_c_t_ae7fbe0037ac898a607fe3648afa61be2}\label{struct_f_u_n_c_s_t_r_u_c_t_ae7fbe0037ac898a607fe3648afa61be2}} +\index{FUNCSTRUCT@{FUNCSTRUCT}!dataImg@{dataImg}} +\index{dataImg@{dataImg}!FUNCSTRUCT@{FUNCSTRUCT}} +\doxysubsubsection{\texorpdfstring{dataImg}{dataImg}} +{\footnotesize\ttfamily void $\ast$ FUNCSTRUCT\+::data\+Img} + +Img data if struct field\textquotesingle{}s value is complex \mbox{\Hypertarget{struct_f_u_n_c_s_t_r_u_c_t_a91ce1300dd1b9c3b18ac38c34171d679}\label{struct_f_u_n_c_s_t_r_u_c_t_a91ce1300dd1b9c3b18ac38c34171d679}} +\index{FUNCSTRUCT@{FUNCSTRUCT}!dataReal@{dataReal}} +\index{dataReal@{dataReal}!FUNCSTRUCT@{FUNCSTRUCT}} +\doxysubsubsection{\texorpdfstring{dataReal}{dataReal}} +{\footnotesize\ttfamily void $\ast$ FUNCSTRUCT\+::data\+Real} + +Real data if struct field\textquotesingle{}s value is real \mbox{\Hypertarget{struct_f_u_n_c_s_t_r_u_c_t_ae298630243ee8fadf8503dd4fd81f52b}\label{struct_f_u_n_c_s_t_r_u_c_t_ae298630243ee8fadf8503dd4fd81f52b}} +\index{FUNCSTRUCT@{FUNCSTRUCT}!key@{key}} +\index{key@{key}!FUNCSTRUCT@{FUNCSTRUCT}} +\doxysubsubsection{\texorpdfstring{key}{key}} +{\footnotesize\ttfamily void $\ast$ FUNCSTRUCT\+::key} + +key of struct field \mbox{\Hypertarget{struct_f_u_n_c_s_t_r_u_c_t_a7512f24fd057d4d93074e9a5c7951157}\label{struct_f_u_n_c_s_t_r_u_c_t_a7512f24fd057d4d93074e9a5c7951157}} +\index{FUNCSTRUCT@{FUNCSTRUCT}!rows@{rows}} +\index{rows@{rows}!FUNCSTRUCT@{FUNCSTRUCT}} +\doxysubsubsection{\texorpdfstring{rows}{rows}} +{\footnotesize\ttfamily int FUNCSTRUCT\+::rows} + +rows dimension of struct field\textquotesingle{}s value \mbox{\Hypertarget{struct_f_u_n_c_s_t_r_u_c_t_a175d20292e70fd1fb89e40d6d128653d}\label{struct_f_u_n_c_s_t_r_u_c_t_a175d20292e70fd1fb89e40d6d128653d}} +\index{FUNCSTRUCT@{FUNCSTRUCT}!str@{str}} +\index{str@{str}!FUNCSTRUCT@{FUNCSTRUCT}} +\doxysubsubsection{\texorpdfstring{str}{str}} +{\footnotesize\ttfamily void $\ast$ FUNCSTRUCT\+::str} + +String data if struct field\textquotesingle{}s value is string \mbox{\Hypertarget{struct_f_u_n_c_s_t_r_u_c_t_a03c3251e6292eeca88505406761e4fd7}\label{struct_f_u_n_c_s_t_r_u_c_t_a03c3251e6292eeca88505406761e4fd7}} +\index{FUNCSTRUCT@{FUNCSTRUCT}!type@{type}} +\index{type@{type}!FUNCSTRUCT@{FUNCSTRUCT}} +\doxysubsubsection{\texorpdfstring{type}{type}} +{\footnotesize\ttfamily \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}} FUNCSTRUCT\+::type} + +Type of value in struct\textquotesingle{}s field + +The documentation for this struct was generated from the following file\+:\begin{DoxyCompactItemize} +\item +src/\mbox{\hyperlink{src_2fun_8h}{fun.\+h}}\end{DoxyCompactItemize} diff --git a/doc/latex/thirdparty_2linux_2include_2fun_8h.tex b/doc/latex/thirdparty_2linux_2include_2fun_8h.tex index ea369bc..f2dcaf9 100644 --- a/doc/latex/thirdparty_2linux_2include_2fun_8h.tex +++ b/doc/latex/thirdparty_2linux_2include_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,10 +17,16 @@ struct \mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}} \doxysubsection*{Enumerations} \begin{DoxyCompactItemize} \item -enum \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134}{FUNCTYPE}} \{ \mbox{\hyperlink{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}{TYPE\+\_\+\+DOUBLE}} +enum \mbox{\hyperlink{thirdparty_2linux_2include_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} @@ -46,21 +54,37 @@ int \mbox{\hyperlink{thirdparty_2linux_2include_2fun_8h_adda0eaf7454844236de5349 \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{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}\label{thirdparty_2linux_2include_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{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc}\label{thirdparty_2linux_2include_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{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}\label{thirdparty_2linux_2include_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{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c}\label{thirdparty_2linux_2include_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{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a019d94f7c571e36215cc1a41e825de0c}\label{thirdparty_2linux_2include_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{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a93b716b9a66d34b56d36773e5337f3dc}\label{thirdparty_2linux_2include_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{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134addb4be6b1cc25112defabef75f73427a}\label{thirdparty_2linux_2include_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{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c}\label{thirdparty_2linux_2include_2fun_8h_a160793ea95e0b5106580229a2a5f1134a9001cd1bc103bb1d664228d46715f65c}} +TYPE\+\_\+\+STRUCT&\\ +\hline + \end{DoxyEnumFields} @@ -75,4 +99,7 @@ TYPE\+\_\+\+STRING&\\ Function to Interact with Octave\textquotesingle{}s API. +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 |