structluwra_1_1Reference.html 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. <!-- HTML header for doxygen 1.8.10-->
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  6. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  7. <meta name="generator" content="Doxygen 1.8.11"/>
  8. <title>Luwra: luwra::Reference Struct Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="stylesheet.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top">
  17. <!-- Generated by Doxygen 1.8.11 -->
  18. <div id="navrow1" class="tabs">
  19. <ul class="tablist">
  20. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  21. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  22. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  23. </ul>
  24. </div>
  25. <div id="navrow2" class="tabs2">
  26. <ul class="tablist">
  27. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  28. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  29. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  30. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  31. </ul>
  32. </div>
  33. <div id="nav-path" class="navpath">
  34. <ul>
  35. <li class="navelem"><a class="el" href="namespaceluwra.html">luwra</a></li><li class="navelem"><a class="el" href="structluwra_1_1Reference.html">Reference</a></li> </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#pub-methods">Public Member Functions</a> &#124;
  41. <a href="#pub-attribs">Public Attributes</a> &#124;
  42. <a href="structluwra_1_1Reference-members.html">List of all members</a> </div>
  43. <div class="headertitle">
  44. <div class="title">luwra::Reference Struct Reference</div> </div>
  45. </div><!--header-->
  46. <div class="contents">
  47. <table class="memberdecls">
  48. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  49. Public Member Functions</h2></td></tr>
  50. <tr class="memitem:a8f276276f86e76b7efb29a46a35a09ce"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1Reference.html#a8f276276f86e76b7efb29a46a35a09ce">Reference</a> (<a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *state, int indexOrRef, bool isIndex=true)</td></tr>
  51. <tr class="separator:a8f276276f86e76b7efb29a46a35a09ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52. <tr class="memitem:a1b705c627c185727126a95f1999aabd9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1Reference.html#a1b705c627c185727126a95f1999aabd9">Reference</a> (<a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *state)</td></tr>
  53. <tr class="separator:a1b705c627c185727126a95f1999aabd9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:a7c5adb1c1ac53741215a418622f6aff7"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  55. <tr class="memitem:a7c5adb1c1ac53741215a418622f6aff7"><td class="memTemplItemLeft" align="right" valign="top">T&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structluwra_1_1Reference.html#a7c5adb1c1ac53741215a418622f6aff7">read</a> () const </td></tr>
  56. <tr class="separator:a7c5adb1c1ac53741215a418622f6aff7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  57. <tr class="memitem:a4c1727cd133912186f078b0d67e890a3"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  58. <tr class="memitem:a4c1727cd133912186f078b0d67e890a3"><td class="memTemplItemLeft" align="right" valign="top">&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structluwra_1_1Reference.html#a4c1727cd133912186f078b0d67e890a3">operator T</a> () const </td></tr>
  59. <tr class="separator:a4c1727cd133912186f078b0d67e890a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. </table><table class="memberdecls">
  61. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
  62. Public Attributes</h2></td></tr>
  63. <tr class="memitem:aab7b0d5abad93dfae819d41853d93dd5"><td class="memItemLeft" align="right" valign="top">const internal::SharedReferenceImpl&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structluwra_1_1Reference.html#aab7b0d5abad93dfae819d41853d93dd5">impl</a></td></tr>
  64. <tr class="separator:aab7b0d5abad93dfae819d41853d93dd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. </table>
  66. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  67. <div class="textblock"><p><a class="el" href="structluwra_1_1Reference.html">Reference</a> to an arbitrary value. </p>
  68. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  69. <a class="anchor" id="a8f276276f86e76b7efb29a46a35a09ce"></a>
  70. <div class="memitem">
  71. <div class="memproto">
  72. <table class="mlabels">
  73. <tr>
  74. <td class="mlabels-left">
  75. <table class="memname">
  76. <tr>
  77. <td class="memname">luwra::Reference::Reference </td>
  78. <td>(</td>
  79. <td class="paramtype"><a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *&#160;</td>
  80. <td class="paramname"><em>state</em>, </td>
  81. </tr>
  82. <tr>
  83. <td class="paramkey"></td>
  84. <td></td>
  85. <td class="paramtype">int&#160;</td>
  86. <td class="paramname"><em>indexOrRef</em>, </td>
  87. </tr>
  88. <tr>
  89. <td class="paramkey"></td>
  90. <td></td>
  91. <td class="paramtype">bool&#160;</td>
  92. <td class="paramname"><em>isIndex</em> = <code>true</code>&#160;</td>
  93. </tr>
  94. <tr>
  95. <td></td>
  96. <td>)</td>
  97. <td></td><td></td>
  98. </tr>
  99. </table>
  100. </td>
  101. <td class="mlabels-right">
  102. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  103. </tr>
  104. </table>
  105. </div><div class="memdoc">
  106. <p>Create a reference to the value at the given index. </p>
  107. </div>
  108. </div>
  109. <a class="anchor" id="a1b705c627c185727126a95f1999aabd9"></a>
  110. <div class="memitem">
  111. <div class="memproto">
  112. <table class="mlabels">
  113. <tr>
  114. <td class="mlabels-left">
  115. <table class="memname">
  116. <tr>
  117. <td class="memname">luwra::Reference::Reference </td>
  118. <td>(</td>
  119. <td class="paramtype"><a class="el" href="namespaceluwra.html#a2c037b44385367826eb4e931b5b8197d">State</a> *&#160;</td>
  120. <td class="paramname"><em>state</em></td><td>)</td>
  121. <td></td>
  122. </tr>
  123. </table>
  124. </td>
  125. <td class="mlabels-right">
  126. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  127. </tr>
  128. </table>
  129. </div><div class="memdoc">
  130. <p>Create a reference to the value at the top of the stack. </p>
  131. </div>
  132. </div>
  133. <h2 class="groupheader">Member Function Documentation</h2>
  134. <a class="anchor" id="a4c1727cd133912186f078b0d67e890a3"></a>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <div class="memtemplate">
  138. template&lt;typename T &gt; </div>
  139. <table class="mlabels">
  140. <tr>
  141. <td class="mlabels-left">
  142. <table class="memname">
  143. <tr>
  144. <td class="memname">luwra::Reference::operator T </td>
  145. <td>(</td>
  146. <td class="paramname"></td><td>)</td>
  147. <td> const</td>
  148. </tr>
  149. </table>
  150. </td>
  151. <td class="mlabels-right">
  152. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  153. </tr>
  154. </table>
  155. </div><div class="memdoc">
  156. <p>Shortcut for <code>read&lt;T&gt;()</code>. </p>
  157. </div>
  158. </div>
  159. <a class="anchor" id="a7c5adb1c1ac53741215a418622f6aff7"></a>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <div class="memtemplate">
  163. template&lt;typename T &gt; </div>
  164. <table class="mlabels">
  165. <tr>
  166. <td class="mlabels-left">
  167. <table class="memname">
  168. <tr>
  169. <td class="memname">T luwra::Reference::read </td>
  170. <td>(</td>
  171. <td class="paramname"></td><td>)</td>
  172. <td> const</td>
  173. </tr>
  174. </table>
  175. </td>
  176. <td class="mlabels-right">
  177. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. <p>Read the referenced value. </p>
  182. </div>
  183. </div>
  184. <h2 class="groupheader">Member Data Documentation</h2>
  185. <a class="anchor" id="aab7b0d5abad93dfae819d41853d93dd5"></a>
  186. <div class="memitem">
  187. <div class="memproto">
  188. <table class="memname">
  189. <tr>
  190. <td class="memname">const internal::SharedReferenceImpl luwra::Reference::impl</td>
  191. </tr>
  192. </table>
  193. </div><div class="memdoc">
  194. </div>
  195. </div>
  196. </div><!-- contents -->
  197. </body>
  198. </html>