blob: af0ba56917b92b664ca2ae2d70b5e2b4721c05df (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
\hypertarget{src_2fun_8h}{}\doxysection{src/fun.h File Reference}
\label{src_2fun_8h}\index{src/fun.h@{src/fun.h}}
\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}}
\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}}
\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
\#define \mbox{\hyperlink{src_2fun_8h_a2ca3f7142a7018d5861959828144a9e9}{fun\+\_\+h\+\_\+\+\_\+}}
\end{DoxyCompactItemize}
\doxysubsection*{Enumerations}
\begin{DoxyCompactItemize}
\item
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{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}}
\}
\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 API Function to call/receive and pass the data to fun API ~\newline
\end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection{Macro Definition Documentation}
\mbox{\Hypertarget{src_2fun_8h_a2ca3f7142a7018d5861959828144a9e9}\label{src_2fun_8h_a2ca3f7142a7018d5861959828144a9e9}}
\index{fun.h@{fun.h}!fun\_h\_\_@{fun\_h\_\_}}
\index{fun\_h\_\_@{fun\_h\_\_}!fun.h@{fun.h}}
\doxysubsubsection{\texorpdfstring{fun\_h\_\_}{fun\_h\_\_}}
{\footnotesize\ttfamily \#define fun\+\_\+h\+\_\+\+\_\+}
\doxysubsection{Enumeration Type Documentation}
\mbox{\Hypertarget{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}\label{src_2fun_8h_a160793ea95e0b5106580229a2a5f1134}}
\index{fun.h@{fun.h}!FUNCTYPE@{FUNCTYPE}}
\index{FUNCTYPE@{FUNCTYPE}!fun.h@{fun.h}}
\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&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&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}
\doxysubsection{Function Documentation}
\mbox{\Hypertarget{src_2fun_8h_adda0eaf7454844236de53495b494cdd4}\label{src_2fun_8h_adda0eaf7454844236de53495b494cdd4}}
\index{fun.h@{fun.h}!fun@{fun}}
\index{fun@{fun}!fun.h@{fun.h}}
\doxysubsubsection{\texorpdfstring{fun()}{fun()}}
{\footnotesize\ttfamily int fun (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{struct_f_u_n_c_a_r_g_s}{FUNCARGS}} $\ast$}]{inp, }\item[{\mbox{\hyperlink{struct_f_u_n_c_c_a_l_l}{FUNCCALL}} $\ast$}]{funcall }\end{DoxyParamCaption})}
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.
|
