File: node183.html

package info (click to toggle)
babel 0.10.2-1
  • links: PTS
  • area: contrib
  • in suites: sarge
  • size: 43,932 kB
  • ctags: 29,707
  • sloc: java: 74,695; ansic: 73,142; cpp: 40,649; sh: 18,411; f90: 10,062; fortran: 6,727; python: 6,406; makefile: 3,866; xml: 118; perl: 48
file content (196 lines) | stat: -rw-r--r-- 8,424 bytes parent folder | download | duplicates (2) 
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<!--Converted with LaTeX2HTML 2002-2-1 (1.70)
original version by:  Nikos Drakos, CBLU, University of Leeds
* revised and updated by:  Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
  Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Interfaces</TITLE>
<META NAME="description" CONTENT="Interfaces">
<META NAME="keywords" CONTENT="users_guide">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">

<META NAME="Generator" CONTENT="LaTeX2HTML v2002-2-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">

<LINK REL="STYLESHEET" HREF="users_guide.css">

<LINK REL="next" HREF="node184.html">
<LINK REL="previous" HREF="node182.html">
<LINK REL="up" HREF="node180.html">
<LINK REL="next" HREF="node184.html">
</HEAD>

<BODY >

<DIV CLASS="navigation"><!--Navigation Panel-->
<A NAME="tex2html3434"
  HREF="node184.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A> 
<A NAME="tex2html3428"
  HREF="node180.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A> 
<A NAME="tex2html3422"
  HREF="node182.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A> 
<A NAME="tex2html3430"
  HREF="node14.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A> 
<A NAME="tex2html3432"
  HREF="node317.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A> 
<BR>
<B> Next:</B> <A NAME="tex2html3435"
  HREF="node184.html">Classes</A>
<B> Up:</B> <A NAME="tex2html3429"
  HREF="node180.html">Basic Structure</A>
<B> Previous:</B> <A NAME="tex2html3423"
  HREF="node182.html">Packages</A>
 &nbsp; <B>  <A NAME="tex2html3431"
  HREF="node14.html">Contents</A></B> 
 &nbsp; <B>  <A NAME="tex2html3433"
  HREF="node317.html">Index</A></B> 
<BR>
<BR></DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION03833000000000000000"></A>
<A NAME="10989"></A>
<BR>
Interfaces
</H2>
Similarly, the XML for interface symbols contain the common elements.  In 
addition, they retain elements and attributes associated with SIDL interfaces.  
These include any extensions, parent interfaces it implements, and its methods.
Method information includes its name, communication mode, short name, name 
extension (for languages that don't support method overloading), comment, 
return type, argument list, and exception list.

<P>
For example, the XML representation of <TT><I CLASS="slanted">sidl.BaseInterface</I></TT> is:

<P>
<BR>
<PRE  CLASS="verbatim">&lt;?xml version="1.0" encoding="UTF-8"?&gt;
&lt;!DOCTYPE Symbol PUBLIC "-//CCA//SIDL Symbol DTD v1.1//EN" "SIDL.dtd"&gt;
&lt;Symbol&gt;
   &lt;SymbolName name="sidl.BaseInterface" version="0.8.2"/&gt;
   &lt;Metadata date="20030320 13:29:02 PST"&gt;
      &lt;MetadataEntry key="source-url" value="file:/home/dahlgren/RELEASE/linux_kcc/share/../../babel/runtime/sidl/sidl.sidl"/&gt;
      &lt;MetadataEntry key="source-line" value="47"/&gt;
      &lt;MetadataEntry key="babel-version" value="0.8.2"/&gt;
   &lt;/Metadata&gt;
   &lt;Comment&gt;
Every interface in &amp;lt;code&amp;gt;SIDL&amp;lt;/code&amp;gt; implicitly inherits
from &amp;lt;code&amp;gt;BaseInterface&amp;lt;/code&amp;gt;, and it is implemented
by &amp;lt;code&amp;gt;BaseClass&amp;lt;/code&amp;gt; below.
   &lt;/Comment&gt;
   &lt;Interface&gt;
      &lt;ExtendsBlock/&gt;
      &lt;AllParentInterfaces/&gt;
      &lt;MethodsBlock&gt;
         &lt;Method communication="normal" copy="false" definition="abstract" extension="" shortname="addRef"&gt;
            &lt;Comment&gt;
&amp;lt;p&amp;gt;
Add one to the intrinsic reference count in the underlying object.
Object in &amp;lt;code&amp;gt;SIDL&amp;lt;/code&amp;gt; have an intrinsic reference count.
Objects continue to exist as long as the reference count is
positive. Clients should call this method whenever they
create another ongoing reference to an object or interface.
&amp;lt;/p&amp;gt;
&amp;lt;p&amp;gt;
This does not have a return value because there is no language
independent type that can refer to an interface or a
class.
&amp;lt;/p&amp;gt;
            &lt;/Comment&gt;
            &lt;Type type="void"/&gt;
            &lt;ArgumentList/&gt;
            &lt;ThrowsList/&gt;
         &lt;/Method&gt;
         &lt;Method communication="normal" copy="false" definition="abstract" extension="" shortname="deleteRef"&gt;
            &lt;Comment&gt;
Decrease by one the intrinsic reference count in the underlying
object, and delete the object if the reference is non-positive.
Objects in &amp;lt;code&amp;gt;SIDL&amp;lt;/code&amp;gt; have an intrinsic reference count.
Clients should call this method whenever they remove a
reference to an object or interface.
            &lt;/Comment&gt;
            &lt;Type type="void"/&gt;
            &lt;ArgumentList/&gt;
            &lt;ThrowsList/&gt;
         &lt;/Method&gt;
         &lt;Method communication="normal" copy="false" definition="abstract" extension="" shortname="isSame"&gt;
            &lt;Comment&gt;
Return true if and only if &amp;lt;code&amp;gt;obj&amp;lt;/code&amp;gt; refers to the same
object as this object.
            &lt;/Comment&gt;
            &lt;Type type="boolean"/&gt;
            &lt;ArgumentList&gt;
               &lt;Argument copy="false" mode="in" name="iobj"&gt;
                  &lt;Type type="symbol"&gt;
                     &lt;SymbolName name="sidl.BaseInterface" version="0.8.2"/&gt;
                  &lt;/Type&gt;
               &lt;/Argument&gt;
            &lt;/ArgumentList&gt;
            &lt;ThrowsList/&gt;
         &lt;/Method&gt;
         &lt;Method communication="normal" copy="false" definition="abstract" extension="" shortname="queryInt"&gt;
            &lt;Comment&gt;
Check whether the object can support the specified interface or
class.  If the &amp;lt;code&amp;gt;SIDL&amp;lt;/code&amp;gt; type name in &amp;lt;code&amp;gt;name&amp;lt;/code&amp;gt;
is supported, then a reference to that object is returned with the
reference count incremented.  The callee will be responsible for
calling &amp;lt;code&amp;gt;deleteRef&amp;lt;/code&amp;gt; on the returned object.  If
the specified type is not supported, then a null reference is
returned.
            &lt;/Comment&gt;
            &lt;Type type="symbol"&gt;
               &lt;SymbolName name="sidl.BaseInterface" version="0.8.2"/&gt;
            &lt;/Type&gt;
            &lt;ArgumentList&gt;
               &lt;Argument copy="false" mode="in" name="name"&gt;
                  &lt;Type type="string"/&gt;
               &lt;/Argument&gt;
            &lt;/ArgumentList&gt;
            &lt;ThrowsList/&gt;
         &lt;/Method&gt;
         &lt;Method communication="normal" copy="false" definition="abstract" extension="" shortname="isType"&gt;
            &lt;Comment&gt;
Return whether this object is an instance of the specified type.
The string name must be the &amp;lt;code&amp;gt;SIDL&amp;lt;/code&amp;gt; type name.  This
routine will return &amp;lt;code&amp;gt;true&amp;lt;/code&amp;gt; if and only if a cast to
the string type name would succeed.
            &lt;/Comment&gt;
            &lt;Type type="boolean"/&gt;
            &lt;ArgumentList&gt;
               &lt;Argument copy="false" mode="in" name="name"&gt;
                  &lt;Type type="string"/&gt;
               &lt;/Argument&gt;
            &lt;/ArgumentList&gt;
            &lt;ThrowsList/&gt;
         &lt;/Method&gt;
         &lt;Method communication="normal" copy="false" definition="abstract" extension="" shortname="getClassInfo"&gt;
            &lt;Comment&gt;
Return the meta-data about the class implementing this interface.
            &lt;/Comment&gt;
            &lt;Type type="symbol"&gt;
               &lt;SymbolName name="sidl.ClassInfo" version="0.8.2"/&gt;
            &lt;/Type&gt;
            &lt;ArgumentList/&gt;
            &lt;ThrowsList/&gt;
         &lt;/Method&gt;
      &lt;/MethodsBlock&gt;
   &lt;/Interface&gt;
&lt;/Symbol&gt;
</PRE></td></tr></table></blockquote>
<P>
<BR><HR>
<ADDRESS>
<br><br>babel-0.10.2<br>users_guide Last Modified 2005-03-23<br><br><a href="http://www.llnl.gov/CASC/components">http://www.llnl.gov/CASC/components</a><br><a href="mailto:components@llnl.gov">components@llnl.gov</a>
</ADDRESS>
</BODY>
</HTML>