SubscriberLayer.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (version 1.7.0_21) on Wed Sep 25 23:19:37 KST 2013 -->
  6. <title>SubscriberLayer</title>
  7. <meta name="date" content="2013-09-25">
  8. <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
  9. </head>
  10. <body>
  11. <script type="text/javascript"><!--
  12. if (location.href.indexOf('is-external=true') == -1) {
  13. parent.document.title="SubscriberLayer";
  14. }
  15. //-->
  16. </script>
  17. <noscript>
  18. <div>JavaScript is disabled on your browser.</div>
  19. </noscript>
  20. <!-- ========= START OF TOP NAVBAR ======= -->
  21. <div class="topNav"><a name="navbar_top">
  22. <!-- -->
  23. </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
  24. <!-- -->
  25. </a>
  26. <ul class="navList" title="Navigation">
  27. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  28. <li><a href="package-summary.html">Package</a></li>
  29. <li class="navBarCell1Rev">Class</li>
  30. <li><a href="package-tree.html">Tree</a></li>
  31. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  32. <li><a href="../../../../../../index-all.html">Index</a></li>
  33. <li><a href="../../../../../../help-doc.html">Help</a></li>
  34. </ul>
  35. </div>
  36. <div class="subNav">
  37. <ul class="navList">
  38. <li><a href="../../../../../../org/ros/android/view/visualization/layer/RobotLayer.html" title="class in org.ros.android.view.visualization.layer"><span class="strong">Prev Class</span></a></li>
  39. <li><a href="../../../../../../org/ros/android/view/visualization/layer/TfLayer.html" title="interface in org.ros.android.view.visualization.layer"><span class="strong">Next Class</span></a></li>
  40. </ul>
  41. <ul class="navList">
  42. <li><a href="../../../../../../index.html?org/ros/android/view/visualization/layer/SubscriberLayer.html" target="_top">Frames</a></li>
  43. <li><a href="SubscriberLayer.html" target="_top">No Frames</a></li>
  44. </ul>
  45. <ul class="navList" id="allclasses_navbar_top">
  46. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  47. </ul>
  48. <div>
  49. <script type="text/javascript"><!--
  50. allClassesLink = document.getElementById("allclasses_navbar_top");
  51. if(window==top) {
  52. allClassesLink.style.display = "block";
  53. }
  54. else {
  55. allClassesLink.style.display = "none";
  56. }
  57. //-->
  58. </script>
  59. </div>
  60. <div>
  61. <ul class="subNavList">
  62. <li>Summary:&nbsp;</li>
  63. <li>Nested&nbsp;|&nbsp;</li>
  64. <li>Field&nbsp;|&nbsp;</li>
  65. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  66. <li><a href="#method_summary">Method</a></li>
  67. </ul>
  68. <ul class="subNavList">
  69. <li>Detail:&nbsp;</li>
  70. <li>Field&nbsp;|&nbsp;</li>
  71. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  72. <li><a href="#method_detail">Method</a></li>
  73. </ul>
  74. </div>
  75. <a name="skip-navbar_top">
  76. <!-- -->
  77. </a></div>
  78. <!-- ========= END OF TOP NAVBAR ========= -->
  79. <!-- ======== START OF CLASS DATA ======== -->
  80. <div class="header">
  81. <div class="subTitle">org.ros.android.view.visualization.layer</div>
  82. <h2 title="Class SubscriberLayer" class="title">Class SubscriberLayer&lt;T&gt;</h2>
  83. </div>
  84. <div class="contentContainer">
  85. <ul class="inheritance">
  86. <li>java.lang.Object</li>
  87. <li>
  88. <ul class="inheritance">
  89. <li><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html" title="class in org.ros.android.view.visualization.layer">org.ros.android.view.visualization.layer.DefaultLayer</a></li>
  90. <li>
  91. <ul class="inheritance">
  92. <li>org.ros.android.view.visualization.layer.SubscriberLayer&lt;T&gt;</li>
  93. </ul>
  94. </li>
  95. </ul>
  96. </li>
  97. </ul>
  98. <div class="description">
  99. <ul class="blockList">
  100. <li class="blockList">
  101. <dl>
  102. <dt>All Implemented Interfaces:</dt>
  103. <dd><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html" title="interface in org.ros.android.view.visualization.layer">Layer</a>, <a href="../../../../../../org/ros/android/view/visualization/OpenGlDrawable.html" title="interface in org.ros.android.view.visualization">OpenGlDrawable</a></dd>
  104. </dl>
  105. <dl>
  106. <dt>Direct Known Subclasses:</dt>
  107. <dd><a href="../../../../../../org/ros/android/view/visualization/layer/CompressedOccupancyGridLayer.html" title="class in org.ros.android.view.visualization.layer">CompressedOccupancyGridLayer</a>, <a href="../../../../../../org/ros/android/view/visualization/layer/GridCellsLayer.html" title="class in org.ros.android.view.visualization.layer">GridCellsLayer</a>, <a href="../../../../../../org/ros/android/view/visualization/layer/LaserScanLayer.html" title="class in org.ros.android.view.visualization.layer">LaserScanLayer</a>, <a href="../../../../../../org/ros/android/view/visualization/layer/OccupancyGridLayer.html" title="class in org.ros.android.view.visualization.layer">OccupancyGridLayer</a>, <a href="../../../../../../org/ros/android/view/visualization/layer/PathLayer.html" title="class in org.ros.android.view.visualization.layer">PathLayer</a>, <a href="../../../../../../org/ros/android/view/visualization/layer/PoseSubscriberLayer.html" title="class in org.ros.android.view.visualization.layer">PoseSubscriberLayer</a></dd>
  108. </dl>
  109. <hr>
  110. <br>
  111. <pre>public class <span class="strong">SubscriberLayer&lt;T&gt;</span>
  112. extends <a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html" title="class in org.ros.android.view.visualization.layer">DefaultLayer</a></pre>
  113. </li>
  114. </ul>
  115. </div>
  116. <div class="summary">
  117. <ul class="blockList">
  118. <li class="blockList">
  119. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  120. <ul class="blockList">
  121. <li class="blockList"><a name="constructor_summary">
  122. <!-- -->
  123. </a>
  124. <h3>Constructor Summary</h3>
  125. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  126. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  127. <tr>
  128. <th class="colOne" scope="col">Constructor and Description</th>
  129. </tr>
  130. <tr class="altColor">
  131. <td class="colOne"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html#SubscriberLayer(org.ros.namespace.GraphName, java.lang.String)">SubscriberLayer</a></strong>(org.ros.namespace.GraphName&nbsp;topicName,
  132. java.lang.String&nbsp;messageType)</code>&nbsp;</td>
  133. </tr>
  134. </table>
  135. </li>
  136. </ul>
  137. <!-- ========== METHOD SUMMARY =========== -->
  138. <ul class="blockList">
  139. <li class="blockList"><a name="method_summary">
  140. <!-- -->
  141. </a>
  142. <h3>Method Summary</h3>
  143. <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  144. <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
  145. <tr>
  146. <th class="colFirst" scope="col">Modifier and Type</th>
  147. <th class="colLast" scope="col">Method and Description</th>
  148. </tr>
  149. <tr class="altColor">
  150. <td class="colFirst"><code>org.ros.node.topic.Subscriber&lt;<a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html" title="type parameter in SubscriberLayer">T</a>&gt;</code></td>
  151. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html#getSubscriber()">getSubscriber</a></strong>()</code>&nbsp;</td>
  152. </tr>
  153. <tr class="rowColor">
  154. <td class="colFirst"><code>void</code></td>
  155. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html#onShutdown(org.ros.android.view.visualization.VisualizationView, org.ros.node.Node)">onShutdown</a></strong>(<a href="../../../../../../org/ros/android/view/visualization/VisualizationView.html" title="class in org.ros.android.view.visualization">VisualizationView</a>&nbsp;view,
  156. org.ros.node.Node&nbsp;node)</code>
  157. <div class="block">Called when the view is removed from the view.</div>
  158. </td>
  159. </tr>
  160. <tr class="altColor">
  161. <td class="colFirst"><code>void</code></td>
  162. <td class="colLast"><code><strong><a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html#onStart(org.ros.node.ConnectedNode, Handler, org.ros.rosjava_geometry.FrameTransformTree, org.ros.android.view.visualization.Camera)">onStart</a></strong>(org.ros.node.ConnectedNode&nbsp;connectedNode,
  163. Handler&nbsp;handler,
  164. org.ros.rosjava_geometry.FrameTransformTree&nbsp;frameTransformTree,
  165. <a href="../../../../../../org/ros/android/view/visualization/Camera.html" title="class in org.ros.android.view.visualization">Camera</a>&nbsp;camera)</code>
  166. <div class="block">Called when the layer is registered at the navigation view.</div>
  167. </td>
  168. </tr>
  169. </table>
  170. <ul class="blockList">
  171. <li class="blockList"><a name="methods_inherited_from_class_org.ros.android.view.visualization.layer.DefaultLayer">
  172. <!-- -->
  173. </a>
  174. <h3>Methods inherited from class&nbsp;org.ros.android.view.visualization.layer.<a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html" title="class in org.ros.android.view.visualization.layer">DefaultLayer</a></h3>
  175. <code><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html#draw(GL10)">draw</a>, <a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html#onTouchEvent(org.ros.android.view.visualization.VisualizationView, MotionEvent)">onTouchEvent</a></code></li>
  176. </ul>
  177. <ul class="blockList">
  178. <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
  179. <!-- -->
  180. </a>
  181. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  182. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  183. </ul>
  184. </li>
  185. </ul>
  186. </li>
  187. </ul>
  188. </div>
  189. <div class="details">
  190. <ul class="blockList">
  191. <li class="blockList">
  192. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  193. <ul class="blockList">
  194. <li class="blockList"><a name="constructor_detail">
  195. <!-- -->
  196. </a>
  197. <h3>Constructor Detail</h3>
  198. <a name="SubscriberLayer(org.ros.namespace.GraphName, java.lang.String)">
  199. <!-- -->
  200. </a>
  201. <ul class="blockListLast">
  202. <li class="blockList">
  203. <h4>SubscriberLayer</h4>
  204. <pre>public&nbsp;SubscriberLayer(org.ros.namespace.GraphName&nbsp;topicName,
  205. java.lang.String&nbsp;messageType)</pre>
  206. </li>
  207. </ul>
  208. </li>
  209. </ul>
  210. <!-- ============ METHOD DETAIL ========== -->
  211. <ul class="blockList">
  212. <li class="blockList"><a name="method_detail">
  213. <!-- -->
  214. </a>
  215. <h3>Method Detail</h3>
  216. <a name="onStart(org.ros.node.ConnectedNode, Handler, org.ros.rosjava_geometry.FrameTransformTree, org.ros.android.view.visualization.Camera)">
  217. <!-- -->
  218. </a>
  219. <ul class="blockList">
  220. <li class="blockList">
  221. <h4>onStart</h4>
  222. <pre>public&nbsp;void&nbsp;onStart(org.ros.node.ConnectedNode&nbsp;connectedNode,
  223. Handler&nbsp;handler,
  224. org.ros.rosjava_geometry.FrameTransformTree&nbsp;frameTransformTree,
  225. <a href="../../../../../../org/ros/android/view/visualization/Camera.html" title="class in org.ros.android.view.visualization">Camera</a>&nbsp;camera)</pre>
  226. <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html#onStart(org.ros.node.ConnectedNode, Handler, org.ros.rosjava_geometry.FrameTransformTree, org.ros.android.view.visualization.Camera)">Layer</a></code></strong></div>
  227. <div class="block">Called when the layer is registered at the navigation view.</div>
  228. <dl>
  229. <dt><strong>Specified by:</strong></dt>
  230. <dd><code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html#onStart(org.ros.node.ConnectedNode, Handler, org.ros.rosjava_geometry.FrameTransformTree, org.ros.android.view.visualization.Camera)">onStart</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html" title="interface in org.ros.android.view.visualization.layer">Layer</a></code></dd>
  231. <dt><strong>Overrides:</strong></dt>
  232. <dd><code><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html#onStart(org.ros.node.ConnectedNode, Handler, org.ros.rosjava_geometry.FrameTransformTree, org.ros.android.view.visualization.Camera)">onStart</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html" title="class in org.ros.android.view.visualization.layer">DefaultLayer</a></code></dd>
  233. </dl>
  234. </li>
  235. </ul>
  236. <a name="onShutdown(org.ros.android.view.visualization.VisualizationView, org.ros.node.Node)">
  237. <!-- -->
  238. </a>
  239. <ul class="blockList">
  240. <li class="blockList">
  241. <h4>onShutdown</h4>
  242. <pre>public&nbsp;void&nbsp;onShutdown(<a href="../../../../../../org/ros/android/view/visualization/VisualizationView.html" title="class in org.ros.android.view.visualization">VisualizationView</a>&nbsp;view,
  243. org.ros.node.Node&nbsp;node)</pre>
  244. <div class="block"><strong>Description copied from interface:&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html#onShutdown(org.ros.android.view.visualization.VisualizationView, org.ros.node.Node)">Layer</a></code></strong></div>
  245. <div class="block">Called when the view is removed from the view.</div>
  246. <dl>
  247. <dt><strong>Specified by:</strong></dt>
  248. <dd><code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html#onShutdown(org.ros.android.view.visualization.VisualizationView, org.ros.node.Node)">onShutdown</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/Layer.html" title="interface in org.ros.android.view.visualization.layer">Layer</a></code></dd>
  249. <dt><strong>Overrides:</strong></dt>
  250. <dd><code><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html#onShutdown(org.ros.android.view.visualization.VisualizationView, org.ros.node.Node)">onShutdown</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/ros/android/view/visualization/layer/DefaultLayer.html" title="class in org.ros.android.view.visualization.layer">DefaultLayer</a></code></dd>
  251. </dl>
  252. </li>
  253. </ul>
  254. <a name="getSubscriber()">
  255. <!-- -->
  256. </a>
  257. <ul class="blockListLast">
  258. <li class="blockList">
  259. <h4>getSubscriber</h4>
  260. <pre>public&nbsp;org.ros.node.topic.Subscriber&lt;<a href="../../../../../../org/ros/android/view/visualization/layer/SubscriberLayer.html" title="type parameter in SubscriberLayer">T</a>&gt;&nbsp;getSubscriber()</pre>
  261. </li>
  262. </ul>
  263. </li>
  264. </ul>
  265. </li>
  266. </ul>
  267. </div>
  268. </div>
  269. <!-- ========= END OF CLASS DATA ========= -->
  270. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  271. <div class="bottomNav"><a name="navbar_bottom">
  272. <!-- -->
  273. </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
  274. <!-- -->
  275. </a>
  276. <ul class="navList" title="Navigation">
  277. <li><a href="../../../../../../overview-summary.html">Overview</a></li>
  278. <li><a href="package-summary.html">Package</a></li>
  279. <li class="navBarCell1Rev">Class</li>
  280. <li><a href="package-tree.html">Tree</a></li>
  281. <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
  282. <li><a href="../../../../../../index-all.html">Index</a></li>
  283. <li><a href="../../../../../../help-doc.html">Help</a></li>
  284. </ul>
  285. </div>
  286. <div class="subNav">
  287. <ul class="navList">
  288. <li><a href="../../../../../../org/ros/android/view/visualization/layer/RobotLayer.html" title="class in org.ros.android.view.visualization.layer"><span class="strong">Prev Class</span></a></li>
  289. <li><a href="../../../../../../org/ros/android/view/visualization/layer/TfLayer.html" title="interface in org.ros.android.view.visualization.layer"><span class="strong">Next Class</span></a></li>
  290. </ul>
  291. <ul class="navList">
  292. <li><a href="../../../../../../index.html?org/ros/android/view/visualization/layer/SubscriberLayer.html" target="_top">Frames</a></li>
  293. <li><a href="SubscriberLayer.html" target="_top">No Frames</a></li>
  294. </ul>
  295. <ul class="navList" id="allclasses_navbar_bottom">
  296. <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
  297. </ul>
  298. <div>
  299. <script type="text/javascript"><!--
  300. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  301. if(window==top) {
  302. allClassesLink.style.display = "block";
  303. }
  304. else {
  305. allClassesLink.style.display = "none";
  306. }
  307. //-->
  308. </script>
  309. </div>
  310. <div>
  311. <ul class="subNavList">
  312. <li>Summary:&nbsp;</li>
  313. <li>Nested&nbsp;|&nbsp;</li>
  314. <li>Field&nbsp;|&nbsp;</li>
  315. <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
  316. <li><a href="#method_summary">Method</a></li>
  317. </ul>
  318. <ul class="subNavList">
  319. <li>Detail:&nbsp;</li>
  320. <li>Field&nbsp;|&nbsp;</li>
  321. <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
  322. <li><a href="#method_detail">Method</a></li>
  323. </ul>
  324. </div>
  325. <a name="skip-navbar_bottom">
  326. <!-- -->
  327. </a></div>
  328. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  329. </body>
  330. </html>