← Back to branch summary

~ubuntu-branches/ubuntu/raring/babel/raring-proposed

« back to all changes in this revision

Viewing changes to doc/html/gov/llnl/babel/backend/matlab/ClientMexStub.html

  • Committer: Bazaar Package Importer
  • Author(s): Adam C. Powell, IV
  • Date: 2008-08-01 07:56:58 UTC
  • mfrom: (3.1.2 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080801075658-9ezcrbh8dcs8lg70
Tags: 1.2.0.dfsg-6
http://bugs.debian.org/483324
Added libparsifal-dev as dependency to libsidl-dev (closes: #483324).

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/gov/llnl/babel/backend/matlab/ClientMexStub.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 
2
<!--NewPage-->
 
3
<HTML>
 
4
<HEAD>
 
5
<!-- Generated by javadoc (build 1.5.0_03) on Sun Nov 04 09:45:43 PST 2007 -->
 
6
<TITLE>
 
7
ClientMexStub
 
8
</TITLE>
 
9
 
 
10
<META NAME="keywords" CONTENT="gov.llnl.babel.backend.matlab.ClientMexStub class">
 
11
 
 
12
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
 
13
 
 
14
<SCRIPT type="text/javascript">
 
15
function windowTitle()
 
16
{
 
17
    parent.document.title="ClientMexStub";
 
18
}
 
19
</SCRIPT>
 
20
<NOSCRIPT>
 
21
</NOSCRIPT>
 
22
 
 
23
</HEAD>
 
24
 
 
25
<BODY BGCOLOR="white" onload="windowTitle();">
 
26
 
 
27
 
 
28
<!-- ========= START OF TOP NAVBAR ======= -->
 
29
<A NAME="navbar_top"><!-- --></A>
 
30
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
 
31
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 
32
<TR>
 
33
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
34
<A NAME="navbar_top_firstrow"><!-- --></A>
 
35
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 
36
  <TR ALIGN="center" VALIGN="top">
 
37
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
38
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
39
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
40
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
41
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
42
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
43
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
44
  </TR>
 
45
</TABLE>
 
46
</TD>
 
47
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
48
</EM>
 
49
</TD>
 
50
</TR>
 
51
 
 
52
<TR>
 
53
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
54
&nbsp;<A HREF="../../../../../gov/llnl/babel/backend/matlab/ClientMatlab.html" title="class in gov.llnl.babel.backend.matlab"><B>PREV CLASS</B></A>&nbsp;
 
55
&nbsp;<A HREF="../../../../../gov/llnl/babel/backend/matlab/GenerateMatlabClient.html" title="class in gov.llnl.babel.backend.matlab"><B>NEXT CLASS</B></A></FONT></TD>
 
56
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
57
  <A HREF="../../../../../index.html?gov/llnl/babel/backend/matlab/ClientMexStub.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 
58
&nbsp;<A HREF="ClientMexStub.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 
59
&nbsp;<SCRIPT type="text/javascript">
 
60
  <!--
 
61
  if(window==top) {
 
62
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 
63
  }
 
64
  //-->
 
65
</SCRIPT>
 
66
<NOSCRIPT>
 
67
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 
68
</NOSCRIPT>
 
69
 
 
70
 
 
71
</FONT></TD>
 
72
</TR>
 
73
<TR>
 
74
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
75
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
76
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
77
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
78
</TR>
 
79
</TABLE>
 
80
<A NAME="skip-navbar_top"></A>
 
81
<!-- ========= END OF TOP NAVBAR ========= -->
 
82
 
 
83
<HR>
 
84
<!-- ======== START OF CLASS DATA ======== -->
 
85
<H2>
 
86
<FONT SIZE="-1">
 
87
gov.llnl.babel.backend.matlab</FONT>
 
88
<BR>
 
89
Class ClientMexStub</H2>
 
90
<PRE>
 
91
java.lang.Object
 
92
  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>gov.llnl.babel.backend.matlab.ClientMexStub</B>
 
93
</PRE>
 
94
<HR>
 
95
<DL>
 
96
<DT><PRE>public class <B>ClientMexStub</B><DT>extends java.lang.Object</DL>
 
97
</PRE>
 
98
 
 
99
<P>
 
100
Class <code>ClientMexStub</code> writes the Matlab native code descriptions that
 
101
 will point to the JNI C code written by <code>ClientJNI</code>.  The class
 
102
 constructor takes a language writer and method <code>generateCode</code>
 
103
 writes the Matlab client code for the specified symbol to the output stream.
 
104
 The language writer output stream is not closed by this object.
 
105
<P>
 
106
 
 
107
<P>
 
108
<HR>
 
109
 
 
110
<P>
 
111
 
 
112
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
 
113
 
 
114
<A NAME="constructor_summary"><!-- --></A>
 
115
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
116
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
117
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 
118
<B>Constructor Summary</B></FONT></TH>
 
119
</TR>
 
120
<TR BGCOLOR="white" CLASS="TableRowColor">
 
121
<TD><CODE><B><A HREF="../../../../../gov/llnl/babel/backend/matlab/ClientMexStub.html#ClientMexStub(gov.llnl.babel.symbols.Extendable, gov.llnl.babel.Context)">ClientMexStub</A></B>(<A HREF="../../../../../gov/llnl/babel/symbols/Extendable.html" title="class in gov.llnl.babel.symbols">Extendable</A>&nbsp;ext,
 
122
              <A HREF="../../../../../gov/llnl/babel/Context.html" title="class in gov.llnl.babel">Context</A>&nbsp;context)</CODE>
 
123
 
 
124
<BR>
 
125
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Create a <code>ClientMexStub</code> object that will write symbol
 
126
 information to the provided output language writer stream.</TD>
 
127
</TR>
 
128
</TABLE>
 
129
&nbsp;
 
130
<!-- ========== METHOD SUMMARY =========== -->
 
131
 
 
132
<A NAME="method_summary"><!-- --></A>
 
133
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
134
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
135
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
 
136
<B>Method Summary</B></FONT></TH>
 
137
</TR>
 
138
<TR BGCOLOR="white" CLASS="TableRowColor">
 
139
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
140
<CODE>static&nbsp;void</CODE></FONT></TD>
 
141
<TD><CODE><B><A HREF="../../../../../gov/llnl/babel/backend/matlab/ClientMexStub.html#generateCode(gov.llnl.babel.symbols.Extendable, gov.llnl.babel.Context)">generateCode</A></B>(<A HREF="../../../../../gov/llnl/babel/symbols/Extendable.html" title="class in gov.llnl.babel.symbols">Extendable</A>&nbsp;ext,
 
142
             <A HREF="../../../../../gov/llnl/babel/Context.html" title="class in gov.llnl.babel">Context</A>&nbsp;context)</CODE>
 
143
 
 
144
<BR>
 
145
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generate Matlab Mex function stub for CLASS symbol.</TD>
 
146
</TR>
 
147
<TR BGCOLOR="white" CLASS="TableRowColor">
 
148
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
 
149
<CODE>&nbsp;void</CODE></FONT></TD>
 
150
<TD><CODE><B><A HREF="../../../../../gov/llnl/babel/backend/matlab/ClientMexStub.html#generateExtendableStub()">generateExtendableStub</A></B>()</CODE>
 
151
 
 
152
<BR>
 
153
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Generate the Mat client mexFunction source for a sidl class or interface type.</TD>
 
154
</TR>
 
155
</TABLE>
 
156
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
 
157
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
158
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
 
159
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
 
160
</TR>
 
161
<TR BGCOLOR="white" CLASS="TableRowColor">
 
162
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
 
163
</TR>
 
164
</TABLE>
 
165
&nbsp;
 
166
<P>
 
167
 
 
168
<!-- ========= CONSTRUCTOR DETAIL ======== -->
 
169
 
 
170
<A NAME="constructor_detail"><!-- --></A>
 
171
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
172
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
173
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 
174
<B>Constructor Detail</B></FONT></TH>
 
175
</TR>
 
176
</TABLE>
 
177
 
 
178
<A NAME="ClientMexStub(gov.llnl.babel.symbols.Extendable, gov.llnl.babel.Context)"><!-- --></A><H3>
 
179
ClientMexStub</H3>
 
180
<PRE>
 
181
public <B>ClientMexStub</B>(<A HREF="../../../../../gov/llnl/babel/symbols/Extendable.html" title="class in gov.llnl.babel.symbols">Extendable</A>&nbsp;ext,
 
182
                     <A HREF="../../../../../gov/llnl/babel/Context.html" title="class in gov.llnl.babel">Context</A>&nbsp;context)</PRE>
 
183
<DL>
 
184
<DD>Create a <code>ClientMexStub</code> object that will write symbol
 
185
 information to the provided output language writer stream.
 
186
<P>
 
187
</DL>
 
188
 
 
189
<!-- ============ METHOD DETAIL ========== -->
 
190
 
 
191
<A NAME="method_detail"><!-- --></A>
 
192
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
 
193
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
 
194
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
 
195
<B>Method Detail</B></FONT></TH>
 
196
</TR>
 
197
</TABLE>
 
198
 
 
199
<A NAME="generateCode(gov.llnl.babel.symbols.Extendable, gov.llnl.babel.Context)"><!-- --></A><H3>
 
200
generateCode</H3>
 
201
<PRE>
 
202
public static void <B>generateCode</B>(<A HREF="../../../../../gov/llnl/babel/symbols/Extendable.html" title="class in gov.llnl.babel.symbols">Extendable</A>&nbsp;ext,
 
203
                                <A HREF="../../../../../gov/llnl/babel/Context.html" title="class in gov.llnl.babel">Context</A>&nbsp;context)
 
204
                         throws <A HREF="../../../../../gov/llnl/babel/backend/CodeGenerationException.html" title="class in gov.llnl.babel.backend">CodeGenerationException</A></PRE>
 
205
<DL>
 
206
<DD>Generate Matlab Mex function stub for CLASS symbol.
 
207
<P>
 
208
<DD><DL>
 
209
 
 
210
<DT><B>Throws:</B>
 
211
<DD><CODE><A HREF="../../../../../gov/llnl/babel/backend/CodeGenerationException.html" title="class in gov.llnl.babel.backend">CodeGenerationException</A></CODE></DL>
 
212
</DD>
 
213
</DL>
 
214
<HR>
 
215
 
 
216
<A NAME="generateExtendableStub()"><!-- --></A><H3>
 
217
generateExtendableStub</H3>
 
218
<PRE>
 
219
public void <B>generateExtendableStub</B>()
 
220
                            throws <A HREF="../../../../../gov/llnl/babel/backend/CodeGenerationException.html" title="class in gov.llnl.babel.backend">CodeGenerationException</A></PRE>
 
221
<DL>
 
222
<DD>Generate the Mat client mexFunction source for a sidl class or interface type.
 
223
 For the most part, the Java source defines the interfaces and classes
 
224
 and the native methods.  All of the real work is done by the JNI code.
 
225
<P>
 
226
<DD><DL>
 
227
 
 
228
<DT><B>Throws:</B>
 
229
<DD><CODE><A HREF="../../../../../gov/llnl/babel/backend/CodeGenerationException.html" title="class in gov.llnl.babel.backend">CodeGenerationException</A></CODE></DL>
 
230
</DD>
 
231
</DL>
 
232
<!-- ========= END OF CLASS DATA ========= -->
 
233
<HR>
 
234
 
 
235
 
 
236
<!-- ======= START OF BOTTOM NAVBAR ====== -->
 
237
<A NAME="navbar_bottom"><!-- --></A>
 
238
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
 
239
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
 
240
<TR>
 
241
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
 
242
<A NAME="navbar_bottom_firstrow"><!-- --></A>
 
243
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 
244
  <TR ALIGN="center" VALIGN="top">
 
245
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
 
246
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
 
247
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
 
248
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
 
249
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
 
250
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
 
251
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
 
252
  </TR>
 
253
</TABLE>
 
254
</TD>
 
255
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
 
256
</EM>
 
257
</TD>
 
258
</TR>
 
259
 
 
260
<TR>
 
261
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
262
&nbsp;<A HREF="../../../../../gov/llnl/babel/backend/matlab/ClientMatlab.html" title="class in gov.llnl.babel.backend.matlab"><B>PREV CLASS</B></A>&nbsp;
 
263
&nbsp;<A HREF="../../../../../gov/llnl/babel/backend/matlab/GenerateMatlabClient.html" title="class in gov.llnl.babel.backend.matlab"><B>NEXT CLASS</B></A></FONT></TD>
 
264
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
 
265
  <A HREF="../../../../../index.html?gov/llnl/babel/backend/matlab/ClientMexStub.html" target="_top"><B>FRAMES</B></A>  &nbsp;
 
266
&nbsp;<A HREF="ClientMexStub.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
 
267
&nbsp;<SCRIPT type="text/javascript">
 
268
  <!--
 
269
  if(window==top) {
 
270
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
 
271
  }
 
272
  //-->
 
273
</SCRIPT>
 
274
<NOSCRIPT>
 
275
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
 
276
</NOSCRIPT>
 
277
 
 
278
 
 
279
</FONT></TD>
 
280
</TR>
 
281
<TR>
 
282
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
283
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
 
284
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
 
285
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
 
286
</TR>
 
287
</TABLE>
 
288
<A NAME="skip-navbar_bottom"></A>
 
289
<!-- ======== END OF BOTTOM NAVBAR ======= -->
 
290
 
 
291
<HR>
 
292
 
 
293
</BODY>
 
294
</HTML>