summaryrefslogtreecommitdiff
path: root/doc/latex/sci__octave_8cpp.tex
blob: 5c9a2d3e5b218fe18f9d88aaf5d70f8789764b7a (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
\hypertarget{sci__octave_8cpp}{}\doxysection{sci\+\_\+gateway/cpp/sci\+\_\+octave.cpp File Reference}
\label{sci__octave_8cpp}\index{sci\_gateway/cpp/sci\_octave.cpp@{sci\_gateway/cpp/sci\_octave.cpp}}
{\ttfamily \#include $<$iostream$>$}\newline
{\ttfamily \#include $<$string$>$}\newline
{\ttfamily \#include \char`\"{}wchar.\+h\char`\"{}}\newline
{\ttfamily \#include $<$cstdlib$>$}\newline
{\ttfamily \#include $<$sstream$>$}\newline
{\ttfamily \#include $<$Scierror.\+h$>$}\newline
{\ttfamily \#include $<$sciprint.\+h$>$}\newline
{\ttfamily \#include $<$api\+\_\+scilab.\+h$>$}\newline
{\ttfamily \#include \char`\"{}localization.\+h\char`\"{}}\newline
{\ttfamily \#include \char`\"{}fun.\+h\char`\"{}}\newline
{\ttfamily \#include $<$cstdio$>$}\newline
{\ttfamily \#include $<$math.\+h$>$}\newline
{\ttfamily \#include $<$stdio.\+h$>$}\newline
{\ttfamily \#include \char`\"{}os\+\_\+string.\+h\char`\"{}}\newline
{\ttfamily \#include $<$stdlib.\+h$>$}\newline
\doxysubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
int \mbox{\hyperlink{sci__octave_8cpp_a74f2258789a64de6417c6d8912144449}{sci\+\_\+octave\+\_\+fun}} (scilab\+Env env, int nin, scilab\+Var $\ast$in, int nopt, scilab\+Opt $\ast$opt, int nout, scilab\+Var $\ast$out)
\begin{DoxyCompactList}\small\item\em Function to connect to Scilab\textquotesingle{}s API. \end{DoxyCompactList}\end{DoxyCompactItemize}


\doxysubsection{Function Documentation}
\mbox{\Hypertarget{sci__octave_8cpp_a74f2258789a64de6417c6d8912144449}\label{sci__octave_8cpp_a74f2258789a64de6417c6d8912144449}} 
\index{sci\_octave.cpp@{sci\_octave.cpp}!sci\_octave\_fun@{sci\_octave\_fun}}
\index{sci\_octave\_fun@{sci\_octave\_fun}!sci\_octave.cpp@{sci\_octave.cpp}}
\doxysubsubsection{\texorpdfstring{sci\_octave\_fun()}{sci\_octave\_fun()}}
{\footnotesize\ttfamily int sci\+\_\+octave\+\_\+fun (\begin{DoxyParamCaption}\item[{scilab\+Env}]{env,  }\item[{int}]{nin,  }\item[{scilab\+Var $\ast$}]{in,  }\item[{int}]{nopt,  }\item[{scilab\+Opt $\ast$}]{opt,  }\item[{int}]{nout,  }\item[{scilab\+Var $\ast$}]{out }\end{DoxyParamCaption})}



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.


\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}