cccd32353842ab0ebcb3f44cf55d87d1e4ba8591
[scilab.git] / scilab / modules / external_objects_java / help / ja_JP / jdeff.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4 *
5 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
6 * Copyright (C) 2010 - 2011 - Calixte DENIZET <calixte@contrib.scilab.org>
7 *
8 * This file must be used under the terms of the CeCILL.
9 * This source file is licensed as described in the file COPYING, which
10 * you should have received as part of this distribution.  The terms
11 * are also available at
12 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
13 *
14 *
15 -->
16
17 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:lang="en" xml:id="jdeff">
18     
19     <refnamediv>
20         
21         <refname>jdeff</refname>
22         
23         <refpurpose>Map a static Java method onto a Scilab macro</refpurpose>
24         
25     </refnamediv>
26     
27     <refsynopsisdiv>
28         
29         <title>Calling Sequence</title>
30         
31         <synopsis>
32             
33             jdeff(className, javaMethodName, scilabMacroName)
34             
35         </synopsis>
36         
37     </refsynopsisdiv>
38     
39     <refsection>
40         
41         <title>Parameters</title>
42         
43         <variablelist>
44             
45             <varlistentry>
46                 
47                 <term>className</term>
48                 
49                 <listitem>
50                     
51                     <para>A string giving the class name</para>
52                     
53                 </listitem>
54                 
55             </varlistentry>
56             
57             <varlistentry>
58                 
59                 <term>javaMethodName</term>
60                 
61                 <listitem>
62                     
63                     <para>A string giving the method name in the class (the method must be static)</para>
64                     
65                 </listitem>
66                 
67             </varlistentry>
68             
69             <varlistentry>
70                 
71                 <term>scilabMacroName</term>
72                 
73                 <listitem>
74                     
75                     <para>A string giving the macro name</para>
76                     
77                 </listitem>
78                 
79             </varlistentry>
80             
81         </variablelist>
82         
83     </refsection>
84     
85     <refsection>
86         
87         <title>Description</title>
88         
89         <para>
90             
91             Provides a simple way to map a static Java method onto a Scilab macro. The result is automatically unwrapped (if it is possible).
92             
93         </para>
94         
95     </refsection>
96     
97     <refsection>
98         
99         <title>Examples</title>
100         
101         <programlisting role="example"><![CDATA[
102                jdeff("java.lang.Double", "parseDouble", "str2number");
103                PI = str2number("3.141592653589");
104                PI - %pi
105       ]]></programlisting>
106         
107     </refsection>
108     
109     <refsection role="see also">
110         
111         <title>See Also</title>
112         
113         <simplelist type="inline">
114             
115             <member>
116                 
117                 <link type="scilab" linkend="scilab.help/deff">deff</link>
118                 
119             </member>
120             
121         </simplelist>
122         
123     </refsection>
124     
125     <refsection>
126         
127         <title>History</title>
128         
129         <revhistory>
130             
131             <revision>
132                 
133                 <revnumber>5.5.0</revnumber>
134                 
135                 <revremark>
136                     
137                     Function introduced. Based on the 'JIMS' module. The main difference in the behavior compared to the JIMS module is that <link linkend="jautoUnwrap">jautoUnwrap</link> is enabled by default.
138                     
139                 </revremark>
140                 
141             </revision>
142             
143         </revhistory>
144         
145     </refsection>
146     
147 </refentry>
148
149
150