首頁 探索 說明
註冊 登入
devn00b
/
EQ2EMu
9
3
複刻 0
檔案 問題管理 59
目錄樹: c82684228b
分支列表 標籤列表
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
python
/
doc
/
html
/
reference
/
object_wrappers
/
boost_python_object_hpp.html

boost_python_object_hpp.html 122 KB
文件歷史 原始文件

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148 
  1. <html>
    2. 

  2. <head>
    3. 

  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
    4. 

  4. <title>boost/python/object.hpp</title>
    5. 

  5. <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
    7. 

  7. <link rel="home" href="../index.html" title="Boost.Python Reference Manual">
    8. 

  8. <link rel="up" href="../object_wrappers.html" title="Chapter&#160;3.&#160;Object Wrappers">
    9. 

  9. <link rel="prev" href="boost_python_long_hpp.html" title="boost/python/long.hpp">
    10. 

  10. <link rel="next" href="boost_python_str_hpp.html" title="boost/python/str.hpp">
    11. 

  11. </head>
    12. 

  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    13. 

  13. <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="" width="" height="" src="../../images/boost.png"></td></tr></table>
    14. 

  14. <hr>
    15. 

  15. <div class="spirit-nav">
    16. 

  16. <a accesskey="p" href="boost_python_long_hpp.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../object_wrappers.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="boost_python_str_hpp.html"><img src="../../images/next.png" alt="Next"></a>
    17. 

  17. </div>
    18. 

  18. <div class="section">
    19. 

  19. <div class="titlepage"><div><div><h2 class="title" style="clear: both">
    20. 

  20. <a name="object_wrappers.boost_python_object_hpp"></a><a class="link" href="boost_python_object_hpp.html" title="boost/python/object.hpp">boost/python/object.hpp</a>
    21. 

  21. </h2></div></div></div>
    22. 

  22. <div class="toc"><dl class="toc">
    23. 

  23. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.introduction">Introduction</a></span></dt>
    24. 

  24. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_slice_nil">Class
    25. 

  25.         <code class="computeroutput"><span class="identifier">slice_nil</span></code></a></span></dt>
    26. 

  26. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_attribute_policies">Class
    27. 

  27.         <code class="computeroutput"><span class="identifier">const_attribute_policies</span></code></a></span></dt>
    28. 

  28. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_attribute_policies_s">Class
    29. 

  29.         <code class="computeroutput"><span class="identifier">const_attribute_policies</span></code>
    30. 

  30.         static functions</a></span></dt>
    31. 

  31. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_attribute_policies">Class
    32. 

  32.         <code class="computeroutput"><span class="identifier">attribute_policies</span></code></a></span></dt>
    33. 

  33. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_attribute_policies_static_">Class
    34. 

  34.         <code class="computeroutput"><span class="identifier">attribute_policies</span></code> static
    35. 

  35.         functions</a></span></dt>
    36. 

  36. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_objattribute_policie">Class
    37. 

  37.         <code class="computeroutput"><span class="identifier">const_objattribute_policies</span></code></a></span></dt>
    38. 

  38. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_objattribute_polici0">Class
    39. 

  39.         <code class="computeroutput"><span class="identifier">const_objattribute_policies</span></code>
    40. 

  40.         static functions</a></span></dt>
    41. 

  41. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_objattribute_policies">Class
    42. 

  42.         <code class="computeroutput"><span class="identifier">objattribute_policies</span></code></a></span></dt>
    43. 

  43. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_objattribute_policies_stat">Class
    44. 

  44.         <code class="computeroutput"><span class="identifier">objattribute_policies</span></code> static
    45. 

  45.         functions</a></span></dt>
    46. 

  46. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_item_policies">Class
    47. 

  47.         <code class="computeroutput"><span class="identifier">const_item_policies</span></code></a></span></dt>
    48. 

  48. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_item_policies_static">Class
    49. 

  49.         <code class="computeroutput"><span class="identifier">const_item_policies</span></code> static
    50. 

  50.         functions</a></span></dt>
    51. 

  51. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_item_policies">Class
    52. 

  52.         <code class="computeroutput"><span class="identifier">item_policies</span></code></a></span></dt>
    53. 

  53. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_item_policies_static_funct">Class
    54. 

  54.         <code class="computeroutput"><span class="identifier">item_policies</span></code> static functions</a></span></dt>
    55. 

  55. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_slice_policies">Class
    56. 

  56.         <code class="computeroutput"><span class="identifier">const_slice_policies</span></code></a></span></dt>
    57. 

  57. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_slice_policies_stati">Class
    58. 

  58.         <code class="computeroutput"><span class="identifier">const_slice_policies</span></code> static
    59. 

  59.         functions</a></span></dt>
    60. 

  60. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_slice_policies">Class
    61. 

  61.         <code class="computeroutput"><span class="identifier">slice_policies</span></code></a></span></dt>
    62. 

  62. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_slice_policies_static_func">Class
    63. 

  63.         <code class="computeroutput"><span class="identifier">slice_policies</span></code> static functions</a></span></dt>
    64. 

  64. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_template_object_operators">Class
    65. 

  65.         template <code class="computeroutput"><span class="identifier">object_operators</span></code></a></span></dt>
    66. 

  66. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_template_object_operators_">Class
    67. 

  67.         template <code class="computeroutput"><span class="identifier">object_operators</span></code>
    68. 

  68.         observer functions</a></span></dt>
    69. 

  69. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_object">Class
    70. 

  70.         <code class="computeroutput"><span class="identifier">object</span></code></a></span></dt>
    71. 

  71. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_object_constructors_and_de">Class
    72. 

  72.         <code class="computeroutput"><span class="identifier">object</span></code> constructors and destructor</a></span></dt>
    73. 

  73. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_object_modifiers">Class
    74. 

  74.         <code class="computeroutput"><span class="identifier">object</span></code> modifiers</a></span></dt>
    75. 

  75. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_template_proxy">Class
    76. 

  76.         template <code class="computeroutput"><span class="identifier">proxy</span></code></a></span></dt>
    77. 

  77. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_template_proxy_observer_fu">Class
    78. 

  78.         template <code class="computeroutput"><span class="identifier">proxy</span></code> observer functions</a></span></dt>
    79. 

  79. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_template_proxy_modifier_fu">Class
    80. 

  80.         template <code class="computeroutput"><span class="identifier">proxy</span></code> modifier functions</a></span></dt>
    81. 

  81. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.functions">Functions</a></span></dt>
    82. 

  82. <dt><span class="section"><a href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.example">Example</a></span></dt>
    83. 

  83. </dl></div>
    84. 

  84. <div class="section">
    85. 

  85. <div class="titlepage"><div><div><h3 class="title">
    86. 

  86. <a name="object_wrappers.boost_python_object_hpp.introduction"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.introduction" title="Introduction">Introduction</a>
    87. 

  87. </h3></div></div></div>
    88. 

  88. <p>
    89. 

  89.           Exposes the generic Python object wrapper class object, and related classes.
    90. 

  90.           In order to avoid some potenential problems with argument-dependent lookup
    91. 

  91.           and the generalized operators defined on object, all these facilities are
    92. 

  92.           defined in namespace boost::python::api, and object is imported into namespace
    93. 

  93.           boost::python with a using-declaration.
    94. 

  94.         </p>
    95. 

  95. </div>
    96. 

  96. <div class="section">
    97. 

  97. <div class="titlepage"><div><div><h3 class="title">
    98. 

  98. <a name="object_wrappers.boost_python_object_hpp.class_slice_nil"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_slice_nil" title="Class slice_nil">Class
    99. 

  99.         <code class="computeroutput"><span class="identifier">slice_nil</span></code></a>
    100. 

  100. </h3></div></div></div>
    101. 

  101. <pre class="programlisting"><span class="keyword">class</span> <span class="identifier">slice_nil</span><span class="special">;</span>
    102. 

  102. <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">_</span> <span class="special">=</span> <span class="identifier">slice_nil</span><span class="special">();</span>
    103. 

  103. </pre>
    104. 

  104. <p>
    105. 

  105.           A type that can be used to get the effect of leaving out an index in a
    106. 

  106.           Python slice expression:
    107. 

  107.         </p>
    108. 

  108. <pre class="programlisting"><span class="special">&gt;&gt;&gt;</span> <span class="identifier">x</span><span class="special">[:-</span><span class="number">1</span><span class="special">]</span>
    109. 

  109. <span class="special">&gt;&gt;&gt;</span> <span class="identifier">x</span><span class="special">[::-</span><span class="number">1</span><span class="special">]</span>
    110. 

  110. </pre>
    111. 

  111. <p>
    112. 

  112.           C++ equivalent:
    113. 

  113.         </p>
    114. 

  114. <pre class="programlisting"><span class="identifier">x</span><span class="special">.</span><span class="identifier">slice</span><span class="special">(</span><span class="identifier">_</span><span class="special">,-</span><span class="number">1</span><span class="special">)</span>
    115. 

  115. <span class="identifier">x</span><span class="special">[</span><span class="identifier">slice</span><span class="special">(</span><span class="identifier">_</span><span class="special">,</span><span class="identifier">_</span><span class="special">,-</span><span class="number">1</span><span class="special">)]</span>
    116. 

  116. </pre>
    117. 

  117. </div>
    118. 

  118. <div class="section">
    119. 

  119. <div class="titlepage"><div><div><h3 class="title">
    120. 

  120. <a name="object_wrappers.boost_python_object_hpp.class_const_attribute_policies"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_attribute_policies" title="Class const_attribute_policies">Class
    121. 

  121.         <code class="computeroutput"><span class="identifier">const_attribute_policies</span></code></a>
    122. 

  122. </h3></div></div></div>
    123. 

  123. <p>
    124. 

  124.           The policies which are used for proxies representing an attribute access
    125. 

  125.           to a const object.
    126. 

  126.         </p>
    127. 

  127. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    128. 

  128. <span class="special">{</span>
    129. 

  129.   <span class="keyword">struct</span> <span class="identifier">const_attribute_policies</span>
    130. 

  130.   <span class="special">{</span>
    131. 

  131.       <span class="keyword">typedef</span> <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">key_type</span><span class="special">;</span>
    132. 

  132.       <span class="keyword">static</span> <span class="identifier">object</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">key</span><span class="special">);</span>
    133. 

  133.   <span class="special">};</span>
    134. 

  134. <span class="special">}}}</span>
    135. 

  135. </pre>
    136. 

  136. </div>
    137. 

  137. <div class="section">
    138. 

  138. <div class="titlepage"><div><div><h3 class="title">
    139. 

  139. <a name="object_wrappers.boost_python_object_hpp.class_const_attribute_policies_s"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_attribute_policies_s" title="Class const_attribute_policies static functions">Class
    140. 

  140.         <code class="computeroutput"><span class="identifier">const_attribute_policies</span></code>
    141. 

  141.         static functions</a>
    142. 

  142. </h3></div></div></div>
    143. 

  143. <pre class="programlisting"><span class="keyword">static</span> <span class="identifier">object</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">key</span><span class="special">);</span>
    144. 

  144. </pre>
    145. 

  145. <div class="variablelist">
    146. 

  146. <p class="title"><b></b></p>
    147. 

  147. <dl class="variablelist">
    148. 

  148. <dt><span class="term">Requires</span></dt>
    149. 

  149. <dd><p>
    150. 

  150.                 key is an <a class="link" href="../glossary.html#ntbs">ntbs</a>.
    151. 

  151.               </p></dd>
    152. 

  152. <dt><span class="term">Effects</span></dt>
    153. 

  153. <dd><p>
    154. 

  154.                 accesses the attribute of target named by key.
    155. 

  155.               </p></dd>
    156. 

  156. <dt><span class="term">Returns</span></dt>
    157. 

  157. <dd><p>
    158. 

  158.                 An object managing the result of the attribute access.
    159. 

  159.               </p></dd>
    160. 

  160. <dt><span class="term">Throws</span></dt>
    161. 

  161. <dd><p>
    162. 

  162.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    163. 

  163.                 if a Python exception is raised.
    164. 

  164.               </p></dd>
    165. 

  165. </dl>
    166. 

  166. </div>
    167. 

  167. </div>
    168. 

  168. <div class="section">
    169. 

  169. <div class="titlepage"><div><div><h3 class="title">
    170. 

  170. <a name="object_wrappers.boost_python_object_hpp.class_attribute_policies"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_attribute_policies" title="Class attribute_policies">Class
    171. 

  171.         <code class="computeroutput"><span class="identifier">attribute_policies</span></code></a>
    172. 

  172. </h3></div></div></div>
    173. 

  173. <p>
    174. 

  174.           The policies which are used for proxies representing an attribute access
    175. 

  175.           to a mutable object.
    176. 

  176.         </p>
    177. 

  177. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    178. 

  178. <span class="special">{</span>
    179. 

  179.   <span class="keyword">struct</span> <span class="identifier">attribute_policies</span> <span class="special">:</span> <span class="identifier">const_attribute_policies</span>
    180. 

  180.   <span class="special">{</span>
    181. 

  181.       <span class="keyword">static</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">set</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">key</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">);</span>
    182. 

  182.       <span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">del</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">target</span><span class="special">,</span> <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">key</span><span class="special">);</span>
    183. 

  183.   <span class="special">};</span>
    184. 

  184. <span class="special">}}}</span>
    185. 

  185. </pre>
    186. 

  186. </div>
    187. 

  187. <div class="section">
    188. 

  188. <div class="titlepage"><div><div><h3 class="title">
    189. 

  189. <a name="object_wrappers.boost_python_object_hpp.class_attribute_policies_static_"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_attribute_policies_static_" title="Class attribute_policies static functions">Class
    190. 

  190.         <code class="computeroutput"><span class="identifier">attribute_policies</span></code> static
    191. 

  191.         functions</a>
    192. 

  192. </h3></div></div></div>
    193. 

  193. <pre class="programlisting"><span class="keyword">static</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">set</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">key</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">);</span>
    194. 

  194. </pre>
    195. 

  195. <div class="variablelist">
    196. 

  196. <p class="title"><b></b></p>
    197. 

  197. <dl class="variablelist">
    198. 

  198. <dt><span class="term">Requires</span></dt>
    199. 

  199. <dd><p>
    200. 

  200.                 key is an <a class="link" href="../glossary.html#ntbs">ntbs</a>.
    201. 

  201.               </p></dd>
    202. 

  202. <dt><span class="term">Effects</span></dt>
    203. 

  203. <dd><p>
    204. 

  204.                 sets the attribute of target named by key to value.
    205. 

  205.               </p></dd>
    206. 

  206. <dt><span class="term">Throws</span></dt>
    207. 

  207. <dd><p>
    208. 

  208.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    209. 

  209.                 if a Python exception is raised.
    210. 

  210.               </p></dd>
    211. 

  211. </dl>
    212. 

  212. </div>
    213. 

  213. <pre class="programlisting"><span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">del</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">target</span><span class="special">,</span> <span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">key</span><span class="special">);</span>
    214. 

  214. </pre>
    215. 

  215. <div class="variablelist">
    216. 

  216. <p class="title"><b></b></p>
    217. 

  217. <dl class="variablelist">
    218. 

  218. <dt><span class="term">Requires</span></dt>
    219. 

  219. <dd><p>
    220. 

  220.                 key is an <a class="link" href="../glossary.html#ntbs">ntbs</a>.
    221. 

  221.               </p></dd>
    222. 

  222. <dt><span class="term">Effects</span></dt>
    223. 

  223. <dd><p>
    224. 

  224.                 deletes the attribute of target named by key.
    225. 

  225.               </p></dd>
    226. 

  226. <dt><span class="term">Throws</span></dt>
    227. 

  227. <dd><p>
    228. 

  228.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    229. 

  229.                 if a Python exception is raised.
    230. 

  230.               </p></dd>
    231. 

  231. </dl>
    232. 

  232. </div>
    233. 

  233. </div>
    234. 

  234. <div class="section">
    235. 

  235. <div class="titlepage"><div><div><h3 class="title">
    236. 

  236. <a name="object_wrappers.boost_python_object_hpp.class_const_objattribute_policie"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_objattribute_policie" title="Class const_objattribute_policies">Class
    237. 

  237.         <code class="computeroutput"><span class="identifier">const_objattribute_policies</span></code></a>
    238. 

  238. </h3></div></div></div>
    239. 

  239. <p>
    240. 

  240.           The policies which are used for proxies representing an attribute access
    241. 

  241.           to a const object when the attribute name is given as a const object.
    242. 

  242.         </p>
    243. 

  243. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    244. 

  244. <span class="special">{</span>
    245. 

  245.   <span class="keyword">struct</span> <span class="identifier">const_objattribute_policies</span>
    246. 

  246.   <span class="special">{</span>
    247. 

  247.       <span class="keyword">typedef</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key_type</span><span class="special">;</span>
    248. 

  248.       <span class="keyword">static</span> <span class="identifier">object</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    249. 

  249.   <span class="special">};</span>
    250. 

  250. <span class="special">}}}</span>
    251. 

  251. </pre>
    252. 

  252. </div>
    253. 

  253. <div class="section">
    254. 

  254. <div class="titlepage"><div><div><h3 class="title">
    255. 

  255. <a name="object_wrappers.boost_python_object_hpp.class_const_objattribute_polici0"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_objattribute_polici0" title="Class const_objattribute_policies static functions">Class
    256. 

  256.         <code class="computeroutput"><span class="identifier">const_objattribute_policies</span></code>
    257. 

  257.         static functions</a>
    258. 

  258. </h3></div></div></div>
    259. 

  259. <pre class="programlisting"><span class="keyword">static</span> <span class="identifier">object</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    260. 

  260. </pre>
    261. 

  261. <div class="variablelist">
    262. 

  262. <p class="title"><b></b></p>
    263. 

  263. <dl class="variablelist">
    264. 

  264. <dt><span class="term">Requires</span></dt>
    265. 

  265. <dd><p>
    266. 

  266.                 key is an object holding a string.
    267. 

  267.               </p></dd>
    268. 

  268. <dt><span class="term">Effects</span></dt>
    269. 

  269. <dd><p>
    270. 

  270.                 accesses the attribute of target named by key.
    271. 

  271.               </p></dd>
    272. 

  272. <dt><span class="term">Returns</span></dt>
    273. 

  273. <dd><p>
    274. 

  274.                 An object managing the result of the attribute access.
    275. 

  275.               </p></dd>
    276. 

  276. <dt><span class="term">Throws</span></dt>
    277. 

  277. <dd><p>
    278. 

  278.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    279. 

  279.                 if a Python exception is raised.
    280. 

  280.               </p></dd>
    281. 

  281. </dl>
    282. 

  282. </div>
    283. 

  283. </div>
    284. 

  284. <div class="section">
    285. 

  285. <div class="titlepage"><div><div><h3 class="title">
    286. 

  286. <a name="object_wrappers.boost_python_object_hpp.class_objattribute_policies"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_objattribute_policies" title="Class objattribute_policies">Class
    287. 

  287.         <code class="computeroutput"><span class="identifier">objattribute_policies</span></code></a>
    288. 

  288. </h3></div></div></div>
    289. 

  289. <p>
    290. 

  290.           The policies which are used for proxies representing an attribute access
    291. 

  291.           to a mutable object when the attribute name is given as a const object.
    292. 

  292.         </p>
    293. 

  293. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    294. 

  294. <span class="special">{</span>
    295. 

  295.   <span class="keyword">struct</span> <span class="identifier">objattribute_policies</span> <span class="special">:</span> <span class="identifier">const_objattribute_policies</span>
    296. 

  296.   <span class="special">{</span>
    297. 

  297.       <span class="keyword">static</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">set</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">);</span>
    298. 

  298.       <span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">del</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    299. 

  299.   <span class="special">};</span>
    300. 

  300. <span class="special">}}}</span>
    301. 

  301. </pre>
    302. 

  302. </div>
    303. 

  303. <div class="section">
    304. 

  304. <div class="titlepage"><div><div><h3 class="title">
    305. 

  305. <a name="object_wrappers.boost_python_object_hpp.class_objattribute_policies_stat"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_objattribute_policies_stat" title="Class objattribute_policies static functions">Class
    306. 

  306.         <code class="computeroutput"><span class="identifier">objattribute_policies</span></code> static
    307. 

  307.         functions</a>
    308. 

  308. </h3></div></div></div>
    309. 

  309. <pre class="programlisting"><span class="keyword">static</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">set</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">);</span>
    310. 

  310. </pre>
    311. 

  311. <div class="variablelist">
    312. 

  312. <p class="title"><b></b></p>
    313. 

  313. <dl class="variablelist">
    314. 

  314. <dt><span class="term">Requires</span></dt>
    315. 

  315. <dd><p>
    316. 

  316.                 key is an object holding a string.
    317. 

  317.               </p></dd>
    318. 

  318. <dt><span class="term">Effects</span></dt>
    319. 

  319. <dd><p>
    320. 

  320.                 sets the attribute of target named by key to value.
    321. 

  321.               </p></dd>
    322. 

  322. <dt><span class="term">Throws</span></dt>
    323. 

  323. <dd><p>
    324. 

  324.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    325. 

  325.                 if a Python exception is raised.
    326. 

  326.               </p></dd>
    327. 

  327. </dl>
    328. 

  328. </div>
    329. 

  329. <pre class="programlisting"><span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">del</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    330. 

  330. </pre>
    331. 

  331. <div class="variablelist">
    332. 

  332. <p class="title"><b></b></p>
    333. 

  333. <dl class="variablelist">
    334. 

  334. <dt><span class="term">Requires</span></dt>
    335. 

  335. <dd><p>
    336. 

  336.                 key is an object holding a string.
    337. 

  337.               </p></dd>
    338. 

  338. <dt><span class="term">Effects</span></dt>
    339. 

  339. <dd><p>
    340. 

  340.                 deletes the attribute of target named by key.
    341. 

  341.               </p></dd>
    342. 

  342. <dt><span class="term">Throws</span></dt>
    343. 

  343. <dd><p>
    344. 

  344.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    345. 

  345.                 if a Python exception is raised.
    346. 

  346.               </p></dd>
    347. 

  347. </dl>
    348. 

  348. </div>
    349. 

  349. </div>
    350. 

  350. <div class="section">
    351. 

  351. <div class="titlepage"><div><div><h3 class="title">
    352. 

  352. <a name="object_wrappers.boost_python_object_hpp.class_const_item_policies"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_item_policies" title="Class const_item_policies">Class
    353. 

  353.         <code class="computeroutput"><span class="identifier">const_item_policies</span></code></a>
    354. 

  354. </h3></div></div></div>
    355. 

  355. <p>
    356. 

  356.           The policies which are used for proxies representing an item access (via
    357. 

  357.           the Python bracket operators []) to a const object.
    358. 

  358.         </p>
    359. 

  359. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    360. 

  360. <span class="special">{</span>
    361. 

  361.   <span class="keyword">struct</span> <span class="identifier">const_item_policies</span>
    362. 

  362.   <span class="special">{</span>
    363. 

  363.       <span class="keyword">typedef</span> <span class="identifier">object</span> <span class="identifier">key_type</span><span class="special">;</span>
    364. 

  364.       <span class="keyword">static</span> <span class="identifier">object</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    365. 

  365.   <span class="special">};</span>
    366. 

  366. <span class="special">}}}</span>
    367. 

  367. </pre>
    368. 

  368. </div>
    369. 

  369. <div class="section">
    370. 

  370. <div class="titlepage"><div><div><h3 class="title">
    371. 

  371. <a name="object_wrappers.boost_python_object_hpp.class_const_item_policies_static"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_item_policies_static" title="Class const_item_policies static functions">Class
    372. 

  372.         <code class="computeroutput"><span class="identifier">const_item_policies</span></code> static
    373. 

  373.         functions</a>
    374. 

  374. </h3></div></div></div>
    375. 

  375. <pre class="programlisting"><span class="keyword">static</span> <span class="identifier">object</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    376. 

  376. </pre>
    377. 

  377. <div class="variablelist">
    378. 

  378. <p class="title"><b></b></p>
    379. 

  379. <dl class="variablelist">
    380. 

  380. <dt><span class="term">Effects</span></dt>
    381. 

  381. <dd><p>
    382. 

  382.                 accesses the item of target specified by key.
    383. 

  383.               </p></dd>
    384. 

  384. <dt><span class="term">Returns</span></dt>
    385. 

  385. <dd><p>
    386. 

  386.                 An object managing the result of the item access.
    387. 

  387.               </p></dd>
    388. 

  388. <dt><span class="term">Throws</span></dt>
    389. 

  389. <dd><p>
    390. 

  390.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    391. 

  391.                 if a Python exception is raised.
    392. 

  392.               </p></dd>
    393. 

  393. </dl>
    394. 

  394. </div>
    395. 

  395. </div>
    396. 

  396. <div class="section">
    397. 

  397. <div class="titlepage"><div><div><h3 class="title">
    398. 

  398. <a name="object_wrappers.boost_python_object_hpp.class_item_policies"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_item_policies" title="Class item_policies">Class
    399. 

  399.         <code class="computeroutput"><span class="identifier">item_policies</span></code></a>
    400. 

  400. </h3></div></div></div>
    401. 

  401. <p>
    402. 

  402.           The policies which are used for proxies representing an item access (via
    403. 

  403.           the Python bracket operators []) to a mutable object.
    404. 

  404.         </p>
    405. 

  405. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    406. 

  406. <span class="special">{</span>
    407. 

  407.   <span class="keyword">struct</span> <span class="identifier">item_policies</span> <span class="special">:</span> <span class="identifier">const_item_policies</span>
    408. 

  408.   <span class="special">{</span>
    409. 

  409.       <span class="keyword">static</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">set</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">);</span>
    410. 

  410.       <span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">del</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    411. 

  411.   <span class="special">};</span>
    412. 

  412. <span class="special">}}}</span>
    413. 

  413. </pre>
    414. 

  414. </div>
    415. 

  415. <div class="section">
    416. 

  416. <div class="titlepage"><div><div><h3 class="title">
    417. 

  417. <a name="object_wrappers.boost_python_object_hpp.class_item_policies_static_funct"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_item_policies_static_funct" title="Class item_policies static functions">Class
    418. 

  418.         <code class="computeroutput"><span class="identifier">item_policies</span></code> static functions</a>
    419. 

  419. </h3></div></div></div>
    420. 

  420. <pre class="programlisting"><span class="keyword">static</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">set</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">);</span>
    421. 

  421. </pre>
    422. 

  422. <div class="variablelist">
    423. 

  423. <p class="title"><b></b></p>
    424. 

  424. <dl class="variablelist">
    425. 

  425. <dt><span class="term">Effects</span></dt>
    426. 

  426. <dd><p>
    427. 

  427.                 sets the item of target specified by key to value.
    428. 

  428.               </p></dd>
    429. 

  429. <dt><span class="term">Throws</span></dt>
    430. 

  430. <dd><p>
    431. 

  431.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    432. 

  432.                 if a Python exception is raised.
    433. 

  433.               </p></dd>
    434. 

  434. </dl>
    435. 

  435. </div>
    436. 

  436. <pre class="programlisting"><span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">del</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    437. 

  437. </pre>
    438. 

  438. <div class="variablelist">
    439. 

  439. <p class="title"><b></b></p>
    440. 

  440. <dl class="variablelist">
    441. 

  441. <dt><span class="term">Effects</span></dt>
    442. 

  442. <dd><p>
    443. 

  443.                 deletes the item of target specified by key.
    444. 

  444.               </p></dd>
    445. 

  445. <dt><span class="term">Throws</span></dt>
    446. 

  446. <dd><p>
    447. 

  447.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    448. 

  448.                 if a Python exception is raised.
    449. 

  449.               </p></dd>
    450. 

  450. </dl>
    451. 

  451. </div>
    452. 

  452. </div>
    453. 

  453. <div class="section">
    454. 

  454. <div class="titlepage"><div><div><h3 class="title">
    455. 

  455. <a name="object_wrappers.boost_python_object_hpp.class_const_slice_policies"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_slice_policies" title="Class const_slice_policies">Class
    456. 

  456.         <code class="computeroutput"><span class="identifier">const_slice_policies</span></code></a>
    457. 

  457. </h3></div></div></div>
    458. 

  458. <p>
    459. 

  459.           The policies which are used for proxies representing an slice access (via
    460. 

  460.           the Python slice notation [x:y]) to a const object.
    461. 

  461.         </p>
    462. 

  462. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    463. 

  463. <span class="special">{</span>
    464. 

  464.   <span class="keyword">struct</span> <span class="identifier">const_slice_policies</span>
    465. 

  465.   <span class="special">{</span>
    466. 

  466.       <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special">&lt;</span><span class="identifier">handle</span><span class="special">&lt;&gt;,</span> <span class="identifier">handle</span><span class="special">&lt;&gt;</span> <span class="special">&gt;</span> <span class="identifier">key_type</span><span class="special">;</span>
    467. 

  467.       <span class="keyword">static</span> <span class="identifier">object</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    468. 

  468.   <span class="special">};</span>
    469. 

  469. <span class="special">}}}</span>
    470. 

  470. </pre>
    471. 

  471. </div>
    472. 

  472. <div class="section">
    473. 

  473. <div class="titlepage"><div><div><h3 class="title">
    474. 

  474. <a name="object_wrappers.boost_python_object_hpp.class_const_slice_policies_stati"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_const_slice_policies_stati" title="Class const_slice_policies static functions">Class
    475. 

  475.         <code class="computeroutput"><span class="identifier">const_slice_policies</span></code> static
    476. 

  476.         functions</a>
    477. 

  477. </h3></div></div></div>
    478. 

  478. <pre class="programlisting"><span class="keyword">static</span> <span class="identifier">object</span> <span class="identifier">get</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    479. 

  479. </pre>
    480. 

  480. <div class="variablelist">
    481. 

  481. <p class="title"><b></b></p>
    482. 

  482. <dl class="variablelist">
    483. 

  483. <dt><span class="term">Effects</span></dt>
    484. 

  484. <dd><p>
    485. 

  485.                 accesses the slice of target specified by key.
    486. 

  486.               </p></dd>
    487. 

  487. <dt><span class="term">Returns</span></dt>
    488. 

  488. <dd><p>
    489. 

  489.                 An object managing the result of the slice access.
    490. 

  490.               </p></dd>
    491. 

  491. <dt><span class="term">Throws</span></dt>
    492. 

  492. <dd><p>
    493. 

  493.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    494. 

  494.                 if a Python exception is raised.
    495. 

  495.               </p></dd>
    496. 

  496. </dl>
    497. 

  497. </div>
    498. 

  498. </div>
    499. 

  499. <div class="section">
    500. 

  500. <div class="titlepage"><div><div><h3 class="title">
    501. 

  501. <a name="object_wrappers.boost_python_object_hpp.class_slice_policies"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_slice_policies" title="Class slice_policies">Class
    502. 

  502.         <code class="computeroutput"><span class="identifier">slice_policies</span></code></a>
    503. 

  503. </h3></div></div></div>
    504. 

  504. <p>
    505. 

  505.           The policies which are used for proxies representing an slice access to
    506. 

  506.           a mutable object.
    507. 

  507.         </p>
    508. 

  508. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    509. 

  509. <span class="special">{</span>
    510. 

  510.   <span class="keyword">struct</span> <span class="identifier">slice_policies</span> <span class="special">:</span> <span class="identifier">const_slice_policies</span>
    511. 

  511.   <span class="special">{</span>
    512. 

  512.       <span class="keyword">static</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">set</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">);</span>
    513. 

  513.       <span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">del</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    514. 

  514.   <span class="special">};</span>
    515. 

  515. <span class="special">}}}</span>
    516. 

  516. </pre>
    517. 

  517. </div>
    518. 

  518. <div class="section">
    519. 

  519. <div class="titlepage"><div><div><h3 class="title">
    520. 

  520. <a name="object_wrappers.boost_python_object_hpp.class_slice_policies_static_func"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_slice_policies_static_func" title="Class slice_policies static functions">Class
    521. 

  521.         <code class="computeroutput"><span class="identifier">slice_policies</span></code> static functions</a>
    522. 

  522. </h3></div></div></div>
    523. 

  523. <pre class="programlisting"><span class="keyword">static</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">set</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">,</span> <span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">value</span><span class="special">);</span>
    524. 

  524. </pre>
    525. 

  525. <div class="variablelist">
    526. 

  526. <p class="title"><b></b></p>
    527. 

  527. <dl class="variablelist">
    528. 

  528. <dt><span class="term">Effects</span></dt>
    529. 

  529. <dd><p>
    530. 

  530.                 sets the slice of target specified by key to value.
    531. 

  531.               </p></dd>
    532. 

  532. <dt><span class="term">Throws</span></dt>
    533. 

  533. <dd><p>
    534. 

  534.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    535. 

  535.                 if a Python exception is raised.
    536. 

  536.               </p></dd>
    537. 

  537. </dl>
    538. 

  538. </div>
    539. 

  539. <pre class="programlisting"><span class="keyword">static</span> <span class="keyword">void</span> <span class="identifier">del</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">target</span><span class="special">,</span> <span class="identifier">key_type</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    540. 

  540. </pre>
    541. 

  541. <div class="variablelist">
    542. 

  542. <p class="title"><b></b></p>
    543. 

  543. <dl class="variablelist">
    544. 

  544. <dt><span class="term">Effects</span></dt>
    545. 

  545. <dd><p>
    546. 

  546.                 deletes the slice of target specified by key.
    547. 

  547.               </p></dd>
    548. 

  548. <dt><span class="term">Throws</span></dt>
    549. 

  549. <dd><p>
    550. 

  550.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    551. 

  551.                 if a Python exception is raised.
    552. 

  552.               </p></dd>
    553. 

  553. </dl>
    554. 

  554. </div>
    555. 

  555. </div>
    556. 

  556. <div class="section">
    557. 

  557. <div class="titlepage"><div><div><h3 class="title">
    558. 

  558. <a name="object_wrappers.boost_python_object_hpp.class_template_object_operators"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_template_object_operators" title="Class template object_operators">Class
    559. 

  559.         template <code class="computeroutput"><span class="identifier">object_operators</span></code></a>
    560. 

  560. </h3></div></div></div>
    561. 

  561. <p>
    562. 

  562.           This is the base class of object and its proxy template used to supply
    563. 

  563.           common interface: member functions, and operators which must be defined
    564. 

  564.           within the class body. Its template parameter U is expected to be a class
    565. 

  565.           derived from object_operators&lt;U&gt;. In practice users should never
    566. 

  566.           use this class directly, but it is documented here because it supplies
    567. 

  567.           important interface to object and its proxies.
    568. 

  568.         </p>
    569. 

  569. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    570. 

  570. <span class="special">{</span>
    571. 

  571.   <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">U</span><span class="special">&gt;</span>
    572. 

  572.   <span class="keyword">class</span> <span class="identifier">object_operators</span>
    573. 

  573.   <span class="special">{</span>
    574. 

  574.    <span class="keyword">public</span><span class="special">:</span>
    575. 

  575.       <span class="comment">// function call</span>
    576. 

  576.       <span class="comment">//</span>
    577. 

  577.       <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()()</span> <span class="keyword">const</span><span class="special">;</span>
    578. 

  578. 

  579.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">A0</span><span class="special">&gt;</span>
    580. 

  580.       <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">A0</span> <span class="keyword">const</span><span class="special">&amp;)</span> <span class="keyword">const</span><span class="special">;</span>
    581. 

  581.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">A0</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">&gt;</span>
    582. 

  582.       <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">A0</span> <span class="keyword">const</span><span class="special">&amp;,</span> <span class="identifier">A1</span> <span class="keyword">const</span><span class="special">&amp;)</span> <span class="keyword">const</span><span class="special">;</span>
    583. 

  583.       <span class="special">...</span>
    584. 

  584.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">A0</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">,...</span><span class="keyword">class</span> <span class="identifier">An</span><span class="special">&gt;</span>
    585. 

  585.       <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">A0</span> <span class="keyword">const</span><span class="special">&amp;,</span> <span class="identifier">A1</span> <span class="keyword">const</span><span class="special">&amp;,...</span><span class="identifier">An</span> <span class="keyword">const</span><span class="special">&amp;)</span> <span class="keyword">const</span><span class="special">;</span>
    586. 

  586. 

  587.       <span class="identifier">detail</span><span class="special">::</span><span class="identifier">args_proxy</span> <span class="keyword">operator</span><span class="special">*</span> <span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
    588. 

  588.       <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">detail</span><span class="special">::</span><span class="identifier">args_proxy</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="identifier">args</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    589. 

  589.       <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">detail</span><span class="special">::</span><span class="identifier">args_proxy</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="identifier">args</span><span class="special">,</span>
    590. 

  590.                         <span class="identifier">detail</span><span class="special">::</span><span class="identifier">kwds_proxy</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="identifier">kwds</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    591. 

  591. 

  592.       <span class="comment">// truth value testing</span>
    593. 

  593.       <span class="comment">//</span>
    594. 

  594.       <span class="keyword">typedef</span> <span class="identifier">unspecified</span> <span class="identifier">bool_type</span><span class="special">;</span>
    595. 

  595.       <span class="keyword">operator</span> <span class="identifier">bool_type</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
    596. 

  596. 

  597.       <span class="comment">// Attribute access</span>
    598. 

  598.       <span class="comment">//</span>
    599. 

  599.       <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">const_object_attribute</span><span class="special">&gt;</span> <span class="identifier">attr</span><span class="special">(</span><span class="keyword">char</span> <span class="keyword">const</span><span class="special">*)</span> <span class="keyword">const</span><span class="special">;</span>
    600. 

  600.       <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">object_attribute</span><span class="special">&gt;</span> <span class="identifier">attr</span><span class="special">(</span><span class="keyword">char</span> <span class="keyword">const</span><span class="special">*);</span>
    601. 

  601.       <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">const_object_objattribute</span><span class="special">&gt;</span> <span class="identifier">attr</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;)</span> <span class="keyword">const</span><span class="special">;</span>
    602. 

  602.       <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">object_objattribute</span><span class="special">&gt;</span> <span class="identifier">attr</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;);</span>
    603. 

  603. 

  604.       <span class="comment">// item access</span>
    605. 

  605.       <span class="comment">//</span>
    606. 

  606.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
    607. 

  607.       <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">const_object_item</span><span class="special">&gt;</span> <span class="keyword">operator</span><span class="special">[](</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    608. 

  608. 

  609.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
    610. 

  610.       <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">object_item</span><span class="special">&gt;</span> <span class="keyword">operator</span><span class="special">[](</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    611. 

  611. 

  612.       <span class="comment">// slicing</span>
    613. 

  613.       <span class="comment">//</span>
    614. 

  614.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">V</span><span class="special">&gt;</span>
    615. 

  615.       <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">const_object_slice</span><span class="special">&gt;</span> <span class="identifier">slice</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">start</span><span class="special">,</span> <span class="identifier">V</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">end</span><span class="special">)</span> <span class="keyword">const</span>
    616. 

  616. 

  617.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">V</span><span class="special">&gt;</span>
    618. 

  618.       <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">object_slice</span><span class="special">&gt;</span> <span class="identifier">slice</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">start</span><span class="special">,</span> <span class="identifier">V</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">end</span><span class="special">);</span>
    619. 

  619.   <span class="special">};</span>
    620. 

  620. <span class="special">}}}</span>
    621. 

  621. </pre>
    622. 

  622. </div>
    623. 

  623. <div class="section">
    624. 

  624. <div class="titlepage"><div><div><h3 class="title">
    625. 

  625. <a name="object_wrappers.boost_python_object_hpp.class_template_object_operators_"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_template_object_operators_" title="Class template object_operators observer functions">Class
    626. 

  626.         template <code class="computeroutput"><span class="identifier">object_operators</span></code>
    627. 

  627.         observer functions</a>
    628. 

  628. </h3></div></div></div>
    629. 

  629. <pre class="programlisting"><span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()()</span> <span class="keyword">const</span><span class="special">;</span>
    630. 

  630. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">A0</span><span class="special">&gt;</span>
    631. 

  631. <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">A0</span> <span class="keyword">const</span><span class="special">&amp;)</span> <span class="keyword">const</span><span class="special">;</span>
    632. 

  632. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">A0</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">&gt;</span>
    633. 

  633. <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">A0</span> <span class="keyword">const</span><span class="special">&amp;,</span> <span class="identifier">A1</span> <span class="keyword">const</span><span class="special">&amp;)</span> <span class="keyword">const</span><span class="special">;</span>
    634. 

  634. <span class="special">...</span>
    635. 

  635. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">A0</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">A1</span><span class="special">,...</span><span class="keyword">class</span> <span class="identifier">An</span><span class="special">&gt;</span>
    636. 

  636. <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">A0</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">a1</span><span class="special">,</span> <span class="identifier">A1</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">a2</span><span class="special">,...</span><span class="identifier">An</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">aN</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    637. 

  637. </pre>
    638. 

  638. <div class="variablelist">
    639. 

  639. <p class="title"><b></b></p>
    640. 

  640. <dl class="variablelist">
    641. 

  641. <dt><span class="term">Effects</span></dt>
    642. 

  642. <dd><p>
    643. 

  643.                 <code class="computeroutput"><span class="identifier">call</span><span class="special">&lt;</span><span class="identifier">object</span><span class="special">&gt;(</span><span class="identifier">object</span><span class="special">(*</span><span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">*&gt;(</span><span class="keyword">this</span><span class="special">)).</span><span class="identifier">ptr</span><span class="special">(),</span>
    644. 

  644.                 <span class="identifier">a1</span><span class="special">,</span>
    645. 

  645.                 <span class="identifier">a2</span><span class="special">,...</span><span class="identifier">aN</span><span class="special">)</span></code>
    646. 

  646.               </p></dd>
    647. 

  647. </dl>
    648. 

  648. </div>
    649. 

  649. <pre class="programlisting"><span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">detail</span><span class="special">::</span><span class="identifier">args_proxy</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="identifier">args</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
    650. 

  650. <div class="variablelist">
    651. 

  651. <p class="title"><b></b></p>
    652. 

  652. <dl class="variablelist">
    653. 

  653. <dt><span class="term">Effects</span></dt>
    654. 

  654. <dd><p>
    655. 

  655.                 <code class="computeroutput"><span class="identifier">call</span> <span class="identifier">object</span>
    656. 

  656.                 <span class="identifier">with</span> <span class="identifier">arguments</span>
    657. 

  657.                 <span class="identifier">given</span> <span class="identifier">by</span>
    658. 

  658.                 <span class="identifier">the</span> <span class="identifier">tuple</span>
    659. 

  659.                 <span class="identifier">args</span></code>
    660. 

  660.               </p></dd>
    661. 

  661. </dl>
    662. 

  662. </div>
    663. 

  663. <pre class="programlisting"><span class="identifier">object</span> <span class="keyword">operator</span><span class="special">()(</span><span class="identifier">detail</span><span class="special">::</span><span class="identifier">args_proxy</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="identifier">args</span><span class="special">,</span>
    664. 

  664.                   <span class="identifier">detail</span><span class="special">::</span><span class="identifier">kwds_proxy</span> <span class="keyword">const</span> <span class="special">&amp;</span><span class="identifier">kwds</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    665. 

  665. </pre>
    666. 

  666. <div class="variablelist">
    667. 

  667. <p class="title"><b></b></p>
    668. 

  668. <dl class="variablelist">
    669. 

  669. <dt><span class="term">Effects</span></dt>
    670. 

  670. <dd><p>
    671. 

  671.                 <code class="computeroutput"><span class="identifier">call</span> <span class="identifier">object</span>
    672. 

  672.                 <span class="identifier">with</span> <span class="identifier">arguments</span>
    673. 

  673.                 <span class="identifier">given</span> <span class="identifier">by</span>
    674. 

  674.                 <span class="identifier">the</span> <span class="identifier">tuple</span>
    675. 

  675.                 <span class="identifier">args</span><span class="special">,</span>
    676. 

  676.                 <span class="keyword">and</span> <span class="identifier">named</span>
    677. 

  677.                 <span class="identifier">arguments</span> <span class="identifier">given</span>
    678. 

  678.                 <span class="identifier">by</span> <span class="identifier">the</span>
    679. 

  679.                 <span class="identifier">dictionary</span> <span class="identifier">kwds</span></code>
    680. 

  680.               </p></dd>
    681. 

  681. </dl>
    682. 

  682. </div>
    683. 

  683. <pre class="programlisting"><span class="keyword">operator</span> <span class="identifier">bool_type</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span></pre>
    684. 

  684. <div class="variablelist">
    685. 

  685. <p class="title"><b></b></p>
    686. 

  686. <dl class="variablelist">
    687. 

  687. <dt><span class="term">Effects</span></dt>
    688. 

  688. <dd><p>
    689. 

  689.                 Tests truth value of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>.
    690. 

  690.               </p></dd>
    691. 

  691. <dt><span class="term">Returns</span></dt>
    692. 

  692. <dd><p>
    693. 

  693.                 <code class="computeroutput"><span class="identifier">call</span><span class="special">&lt;</span><span class="identifier">object</span><span class="special">&gt;(</span><span class="identifier">object</span><span class="special">(*</span><span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">*&gt;(</span><span class="keyword">this</span><span class="special">)).</span><span class="identifier">ptr</span><span class="special">(),</span>
    694. 

  694.                 <span class="identifier">a1</span><span class="special">,</span>
    695. 

  695.                 <span class="identifier">a2</span><span class="special">,...</span><span class="identifier">aN</span><span class="special">)</span></code>
    696. 

  696.               </p></dd>
    697. 

  697. </dl>
    698. 

  698. </div>
    699. 

  699. <pre class="programlisting"><span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">const_object_attribute</span><span class="special">&gt;</span> <span class="identifier">attr</span><span class="special">(</span><span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">name</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    700. 

  700. <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">object_attribute</span><span class="special">&gt;</span> <span class="identifier">attr</span><span class="special">(</span><span class="keyword">char</span> <span class="keyword">const</span><span class="special">*</span> <span class="identifier">name</span><span class="special">);</span>
    701. 

  701. </pre>
    702. 

  702. <div class="variablelist">
    703. 

  703. <p class="title"><b></b></p>
    704. 

  704. <dl class="variablelist">
    705. 

  705. <dt><span class="term">Requires</span></dt>
    706. 

  706. <dd><p>
    707. 

  707.                 name is an <a class="link" href="../glossary.html#ntbs">ntbs</a>.
    708. 

  708.               </p></dd>
    709. 

  709. <dt><span class="term">Effects</span></dt>
    710. 

  710. <dd><p>
    711. 

  711.                 accesses the named attribute of *this.
    712. 

  712.               </p></dd>
    713. 

  713. <dt><span class="term">Returns</span></dt>
    714. 

  714. <dd><p>
    715. 

  715.                 a proxy object which binds <code class="computeroutput"><span class="identifier">object</span><span class="special">(*</span><span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">*&gt;(</span><span class="keyword">this</span><span class="special">))</span></code> as its target, and name as its
    716. 

  716.                 key.
    717. 

  717.               </p></dd>
    718. 

  718. </dl>
    719. 

  719. </div>
    720. 

  720. <pre class="programlisting"><span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">const_object_objattribute</span><span class="special">&gt;</span> <span class="identifier">attr</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="identifier">name</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    721. 

  721. <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">object_objattribute</span><span class="special">&gt;</span> <span class="identifier">attr</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="identifier">name</span><span class="special">);</span>
    722. 

  722. </pre>
    723. 

  723. <div class="variablelist">
    724. 

  724. <p class="title"><b></b></p>
    725. 

  725. <dl class="variablelist">
    726. 

  726. <dt><span class="term">Requires</span></dt>
    727. 

  727. <dd><p>
    728. 

  728.                 name is a object holding a string.
    729. 

  729.               </p></dd>
    730. 

  730. <dt><span class="term">Effects</span></dt>
    731. 

  731. <dd><p>
    732. 

  732.                 accesses the named attribute of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>.
    733. 

  733.               </p></dd>
    734. 

  734. <dt><span class="term">Returns</span></dt>
    735. 

  735. <dd><p>
    736. 

  736.                 a proxy object which binds <code class="computeroutput"><span class="identifier">object</span><span class="special">(*</span><span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">*&gt;(</span><span class="keyword">this</span><span class="special">))</span></code> as its target, and name as its
    737. 

  737.                 key.
    738. 

  738.               </p></dd>
    739. 

  739. </dl>
    740. 

  740. </div>
    741. 

  741. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
    742. 

  742. <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">const_object_item</span><span class="special">&gt;</span> <span class="keyword">operator</span><span class="special">[](</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    743. 

  743. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
    744. 

  744. <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">object_item</span><span class="special">&gt;</span> <span class="keyword">operator</span><span class="special">[](</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">key</span><span class="special">);</span>
    745. 

  745. </pre>
    746. 

  746. <div class="variablelist">
    747. 

  747. <p class="title"><b></b></p>
    748. 

  748. <dl class="variablelist">
    749. 

  749. <dt><span class="term">Effects</span></dt>
    750. 

  750. <dd><p>
    751. 

  751.                 accesses the item of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> indicated by key.
    752. 

  752.               </p></dd>
    753. 

  753. <dt><span class="term">Returns</span></dt>
    754. 

  754. <dd><p>
    755. 

  755.                 a proxy object which binds <code class="computeroutput"><span class="identifier">object</span><span class="special">(*</span><span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">*&gt;(</span><span class="keyword">this</span><span class="special">))</span></code> as its target, and object(key)
    756. 

  756.                 as its key.
    757. 

  757.               </p></dd>
    758. 

  758. </dl>
    759. 

  759. </div>
    760. 

  760. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">V</span><span class="special">&gt;</span>
    761. 

  761. <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">const_object_slice</span><span class="special">&gt;</span> <span class="identifier">slice</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">start</span><span class="special">;</span> <span class="identifier">start</span><span class="special">,</span> <span class="identifier">V</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">finish</span><span class="special">)</span> <span class="keyword">const</span>
    762. 

  762. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">class</span> <span class="identifier">V</span><span class="special">&gt;</span>
    763. 

  763. <span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">object_slice</span><span class="special">&gt;</span> <span class="identifier">slice</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">start</span><span class="special">;</span> <span class="identifier">start</span><span class="special">,</span> <span class="identifier">V</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">finish</span><span class="special">);</span>
    764. 

  764. </pre>
    765. 

  765. <div class="variablelist">
    766. 

  766. <p class="title"><b></b></p>
    767. 

  767. <dl class="variablelist">
    768. 

  768. <dt><span class="term">Effects</span></dt>
    769. 

  769. <dd><p>
    770. 

  770.                 accesses the slice of <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code> indicated by <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">make_pair</span><span class="special">(</span><span class="identifier">object</span><span class="special">(</span><span class="identifier">start</span><span class="special">),</span> <span class="identifier">object</span><span class="special">(</span><span class="identifier">finish</span><span class="special">))</span></code>.
    771. 

  771.               </p></dd>
    772. 

  772. <dt><span class="term">Returns</span></dt>
    773. 

  773. <dd><p>
    774. 

  774.                 a proxy object which binds <code class="computeroutput"><span class="identifier">object</span><span class="special">(*</span><span class="keyword">static_cast</span><span class="special">&lt;</span><span class="identifier">U</span><span class="special">*&gt;(</span><span class="keyword">this</span><span class="special">))</span></code> as its target, and <code class="computeroutput"><span class="identifier">std</span><span class="special">::</span><span class="identifier">make_pair</span><span class="special">(</span><span class="identifier">object</span><span class="special">(</span><span class="identifier">start</span><span class="special">),</span>
    775. 

  775.                 <span class="identifier">object</span><span class="special">(</span><span class="identifier">finish</span><span class="special">))</span></code>
    776. 

  776.                 as its key.
    777. 

  777.               </p></dd>
    778. 

  778. </dl>
    779. 

  779. </div>
    780. 

  780. </div>
    781. 

  781. <div class="section">
    782. 

  782. <div class="titlepage"><div><div><h3 class="title">
    783. 

  783. <a name="object_wrappers.boost_python_object_hpp.class_object"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_object" title="Class object">Class
    784. 

  784.         <code class="computeroutput"><span class="identifier">object</span></code></a>
    785. 

  785. </h3></div></div></div>
    786. 

  786. <p>
    787. 

  787.           The intention is that object acts as much like a Python variable as possible.
    788. 

  788.           Thus expressions you'd expect to work in Python should generally work in
    789. 

  789.           the same way from C++. Most of object's interface is provided by its base
    790. 

  790.           class <code class="computeroutput"><span class="identifier">object_operators</span><span class="special">&lt;</span><span class="identifier">object</span><span class="special">&gt;</span></code>, and the free functions defined in
    791. 

  791.           this header.
    792. 

  792.         </p>
    793. 

  793. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    794. 

  794. <span class="special">{</span>
    795. 

  795.   <span class="keyword">class</span> <span class="identifier">object</span> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">object_operators</span><span class="special">&lt;</span><span class="identifier">object</span><span class="special">&gt;</span>
    796. 

  796.   <span class="special">{</span>
    797. 

  797.    <span class="keyword">public</span><span class="special">:</span>
    798. 

  798.       <span class="identifier">object</span><span class="special">();</span>
    799. 

  799.       <span class="identifier">object</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;);</span>
    800. 

  800.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
    801. 

  801.       <span class="keyword">explicit</span> <span class="identifier">object</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">);</span>
    802. 

  802. 

  803.       <span class="special">~</span><span class="identifier">object</span><span class="special">();</span>
    804. 

  804. 

  805.       <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;);</span>
    806. 

  806.       <span class="identifier">PyObject</span><span class="special">*</span> <span class="identifier">ptr</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
    807. 

  807.       <span class="keyword">bool</span> <span class="identifier">is_none</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
    808. 

  808.   <span class="special">};</span>
    809. 

  809. <span class="special">}}}</span>
    810. 

  810. </pre>
    811. 

  811. </div>
    812. 

  812. <div class="section">
    813. 

  813. <div class="titlepage"><div><div><h3 class="title">
    814. 

  814. <a name="object_wrappers.boost_python_object_hpp.class_object_constructors_and_de"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_object_constructors_and_de" title="Class object constructors and destructor">Class
    815. 

  815.         <code class="computeroutput"><span class="identifier">object</span></code> constructors and destructor</a>
    816. 

  816. </h3></div></div></div>
    817. 

  817. <pre class="programlisting"><span class="identifier">object</span><span class="special">();</span></pre>
    818. 

  818. <div class="variablelist">
    819. 

  819. <p class="title"><b></b></p>
    820. 

  820. <dl class="variablelist">
    821. 

  821. <dt><span class="term">Effects</span></dt>
    822. 

  822. <dd><p>
    823. 

  823.                 Constructs an object managing a reference to the Python None object.
    824. 

  824.               </p></dd>
    825. 

  825. <dt><span class="term">Throws</span></dt>
    826. 

  826. <dd><p>
    827. 

  827.                 nothing.
    828. 

  828.               </p></dd>
    829. 

  829. </dl>
    830. 

  830. </div>
    831. 

  831. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
    832. 

  832. <span class="keyword">explicit</span> <span class="identifier">object</span><span class="special">(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">);</span>
    833. 

  833. </pre>
    834. 

  834. <div class="variablelist">
    835. 

  835. <p class="title"><b></b></p>
    836. 

  836. <dl class="variablelist">
    837. 

  837. <dt><span class="term">Effects</span></dt>
    838. 

  838. <dd><p>
    839. 

  839.                 converts x to python and manages a reference to it.
    840. 

  840.               </p></dd>
    841. 

  841. <dt><span class="term">Throws</span></dt>
    842. 

  842. <dd><p>
    843. 

  843.                 <a class="link" href="../high_level_components/boost_python_errors_hpp.html#high_level_components.boost_python_errors_hpp.class_error_already_set" title="Class error_already_set">error_already_set</a>
    844. 

  844.                 and sets a Python TypeError exception if no such conversion is possible.
    845. 

  845.               </p></dd>
    846. 

  846. </dl>
    847. 

  847. </div>
    848. 

  848. <pre class="programlisting"><span class="special">~</span><span class="identifier">object</span><span class="special">();</span>
    849. 

  849. </pre>
    850. 

  850. <div class="variablelist">
    851. 

  851. <p class="title"><b></b></p>
    852. 

  852. <dl class="variablelist">
    853. 

  853. <dt><span class="term">Effects</span></dt>
    854. 

  854. <dd><p>
    855. 

  855.                 decrements the reference count of the internally-held object.
    856. 

  856.               </p></dd>
    857. 

  857. </dl>
    858. 

  858. </div>
    859. 

  859. </div>
    860. 

  860. <div class="section">
    861. 

  861. <div class="titlepage"><div><div><h3 class="title">
    862. 

  862. <a name="object_wrappers.boost_python_object_hpp.class_object_modifiers"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_object_modifiers" title="Class object modifiers">Class
    863. 

  863.         <code class="computeroutput"><span class="identifier">object</span></code> modifiers</a>
    864. 

  864. </h3></div></div></div>
    865. 

  865. <pre class="programlisting"><span class="identifier">PyObject</span><span class="special">*</span> <span class="identifier">ptr</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span></pre>
    866. 

  866. <div class="variablelist">
    867. 

  867. <p class="title"><b></b></p>
    868. 

  868. <dl class="variablelist">
    869. 

  869. <dt><span class="term">Returns</span></dt>
    870. 

  870. <dd><p>
    871. 

  871.                 a pointer to the internally-held Python object.
    872. 

  872.               </p></dd>
    873. 

  873. </dl>
    874. 

  874. </div>
    875. 

  875. <pre class="programlisting"><span class="keyword">bool</span> <span class="identifier">is_none</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span></pre>
    876. 

  876. <div class="variablelist">
    877. 

  877. <p class="title"><b></b></p>
    878. 

  878. <dl class="variablelist">
    879. 

  879. <dt><span class="term">Returns</span></dt>
    880. 

  880. <dd><p>
    881. 

  881.                 result of <code class="computeroutput"><span class="special">(</span><span class="identifier">ptr</span><span class="special">()</span> <span class="special">==</span> <span class="identifier">Py_None</span><span class="special">)</span></code>
    882. 

  882.               </p></dd>
    883. 

  883. </dl>
    884. 

  884. </div>
    885. 

  885. </div>
    886. 

  886. <div class="section">
    887. 

  887. <div class="titlepage"><div><div><h3 class="title">
    888. 

  888. <a name="object_wrappers.boost_python_object_hpp.class_template_proxy"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_template_proxy" title="Class template proxy">Class
    889. 

  889.         template <code class="computeroutput"><span class="identifier">proxy</span></code></a>
    890. 

  890. </h3></div></div></div>
    891. 

  891. <p>
    892. 

  892.           This template is instantiated with various Policies described in this document
    893. 

  893.           in order to implement attribute, item, and slice access for object. It
    894. 

  894.           stores an object of type Policies::key_type.
    895. 

  895.         </p>
    896. 

  896. <pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">boost</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">python</span> <span class="special">{</span> <span class="keyword">namespace</span> <span class="identifier">api</span>
    897. 

  897. <span class="special">{</span>
    898. 

  898.   <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">Policies</span><span class="special">&gt;</span>
    899. 

  899.   <span class="keyword">class</span> <span class="identifier">proxy</span> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">object_operators</span><span class="special">&lt;</span><span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">Policies</span><span class="special">&gt;</span> <span class="special">&gt;</span>
    900. 

  900.   <span class="special">{</span>
    901. 

  901.    <span class="keyword">public</span><span class="special">:</span>
    902. 

  902.       <span class="keyword">operator</span> <span class="identifier">object</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
    903. 

  903. 

  904.       <span class="identifier">proxy</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="identifier">proxy</span> <span class="keyword">const</span><span class="special">&amp;)</span> <span class="keyword">const</span><span class="special">;</span>
    905. 

  905.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
    906. 

  906.       <span class="keyword">inline</span> <span class="identifier">proxy</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    907. 

  907. 

  908.       <span class="keyword">void</span> <span class="identifier">del</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span>
    909. 

  909. 

  910.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    911. 

  911.       <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">+=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    912. 

  912.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    913. 

  913.       <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">-=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    914. 

  914.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    915. 

  915.       <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">*=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    916. 

  916.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    917. 

  917.       <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">/=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    918. 

  918.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    919. 

  919.       <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">%=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    920. 

  920.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    921. 

  921.       <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">&lt;&lt;=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    922. 

  922.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    923. 

  923.       <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">&gt;&gt;=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    924. 

  924.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    925. 

  925.       <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">&amp;=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    926. 

  926.       <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    927. 

  927.       <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">|=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    928. 

  928.   <span class="special">};</span>
    929. 

  929. <span class="special">}}}</span>
    930. 

  930. </pre>
    931. 

  931. </div>
    932. 

  932. <div class="section">
    933. 

  933. <div class="titlepage"><div><div><h3 class="title">
    934. 

  934. <a name="object_wrappers.boost_python_object_hpp.class_template_proxy_observer_fu"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_template_proxy_observer_fu" title="Class template proxy observer functions">Class
    935. 

  935.         template <code class="computeroutput"><span class="identifier">proxy</span></code> observer functions</a>
    936. 

  936. </h3></div></div></div>
    937. 

  937. <pre class="programlisting"><span class="keyword">operator</span> <span class="identifier">object</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span></pre>
    938. 

  938. <div class="variablelist">
    939. 

  939. <p class="title"><b></b></p>
    940. 

  940. <dl class="variablelist">
    941. 

  941. <dt><span class="term">Effects</span></dt>
    942. 

  942. <dd><p>
    943. 

  943.                 applies <code class="computeroutput"><span class="identifier">Policies</span><span class="special">::</span><span class="identifier">get</span><span class="special">(</span><span class="identifier">target</span><span class="special">,</span> <span class="identifier">key</span><span class="special">)</span></code> with the proxy's target and key
    944. 

  944.                 objects.
    945. 

  945.               </p></dd>
    946. 

  946. </dl>
    947. 

  947. </div>
    948. 

  948. </div>
    949. 

  949. <div class="section">
    950. 

  950. <div class="titlepage"><div><div><h3 class="title">
    951. 

  951. <a name="object_wrappers.boost_python_object_hpp.class_template_proxy_modifier_fu"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.class_template_proxy_modifier_fu" title="Class template proxy modifier functions">Class
    952. 

  952.         template <code class="computeroutput"><span class="identifier">proxy</span></code> modifier functions</a>
    953. 

  953. </h3></div></div></div>
    954. 

  954. <pre class="programlisting"><span class="identifier">proxy</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="identifier">proxy</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    955. 

  955. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
    956. 

  956. <span class="keyword">inline</span> <span class="identifier">proxy</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">=(</span><span class="identifier">T</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
    957. 

  957. </pre>
    958. 

  958. <div class="variablelist">
    959. 

  959. <p class="title"><b></b></p>
    960. 

  960. <dl class="variablelist">
    961. 

  961. <dt><span class="term">Effects</span></dt>
    962. 

  962. <dd><p>
    963. 

  963.                 <code class="computeroutput"><span class="identifier">Policies</span><span class="special">::</span><span class="identifier">set</span><span class="special">(</span><span class="identifier">target</span><span class="special">,</span>
    964. 

  964.                 <span class="identifier">key</span> <span class="special">,</span>
    965. 

  965.                 <span class="identifier">object</span><span class="special">(</span><span class="identifier">rhs</span><span class="special">))</span></code>
    966. 

  966.                 with the proxy's target and key objects.
    967. 

  967.               </p></dd>
    968. 

  968. </dl>
    969. 

  969. </div>
    970. 

  970. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    971. 

  971. <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">+=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    972. 

  972. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    973. 

  973. <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">-=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    974. 

  974. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    975. 

  975. <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">*=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    976. 

  976. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    977. 

  977. <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">/=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    978. 

  978. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    979. 

  979. <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">%=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    980. 

  980. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    981. 

  981. <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">&lt;&lt;=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    982. 

  982. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    983. 

  983. <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">&gt;&gt;=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    984. 

  984. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    985. 

  985. <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">&amp;=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    986. 

  986. <span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span>
    987. 

  987. <span class="identifier">proxy</span> <span class="keyword">operator</span><span class="special">|=(</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">rhs</span><span class="special">);</span>
    988. 

  988. </pre>
    989. 

  989. <div class="variablelist">
    990. 

  990. <p class="title"><b></b></p>
    991. 

  991. <dl class="variablelist">
    992. 

  992. <dt><span class="term">Effects</span></dt>
    993. 

  993. <dd><p>
    994. 

  994.                 for a given <code class="computeroutput"><span class="keyword">operator</span><span class="error">@</span><span class="special">=</span></code>,
    995. 

  995.                 <code class="computeroutput"><span class="identifier">object</span><span class="special">(*</span><span class="keyword">this</span><span class="special">)</span> <span class="error">@</span><span class="special">=</span> <span class="identifier">rhs</span><span class="special">;</span></code>
    996. 

  996.               </p></dd>
    997. 

  997. <dt><span class="term">Returns</span></dt>
    998. 

  998. <dd><p>
    999. 

  999.                 <code class="computeroutput"><span class="special">*</span><span class="keyword">this</span></code>
    1000. 

  1000.               </p></dd>
    1001. 

  1001. </dl>
    1002. 

  1002. </div>
    1003. 

  1003. <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">del</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span></pre>
    1004. 

  1004. <div class="variablelist">
    1005. 

  1005. <p class="title"><b></b></p>
    1006. 

  1006. <dl class="variablelist">
    1007. 

  1007. <dt><span class="term">Effects</span></dt>
    1008. 

  1008. <dd><p>
    1009. 

  1009.                 Policies::del(target, key ) with the proxy's target and key objects.
    1010. 

  1010.               </p></dd>
    1011. 

  1011. </dl>
    1012. 

  1012. </div>
    1013. 

  1013. </div>
    1014. 

  1014. <div class="section">
    1015. 

  1015. <div class="titlepage"><div><div><h3 class="title">
    1016. 

  1016. <a name="object_wrappers.boost_python_object_hpp.functions"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.functions" title="Functions">Functions</a>
    1017. 

  1017. </h3></div></div></div>
    1018. 

  1018. <pre class="programlisting"><span class="keyword">template</span> <span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">T</span><span class="special">&gt;</span>
    1019. 

  1019. <span class="keyword">void</span> <span class="identifier">del</span><span class="special">(</span><span class="identifier">proxy</span><span class="special">&lt;</span><span class="identifier">T</span><span class="special">&gt;</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">x</span><span class="special">);</span>
    1020. 

  1020. </pre>
    1021. 

  1021. <div class="variablelist">
    1022. 

  1022. <p class="title"><b></b></p>
    1023. 

  1023. <dl class="variablelist">
    1024. 

  1024. <dt><span class="term">Effects</span></dt>
    1025. 

  1025. <dd><p>
    1026. 

  1026.                 <code class="computeroutput"><span class="identifier">x</span><span class="special">.</span><span class="identifier">del</span><span class="special">()</span></code>
    1027. 

  1027.               </p></dd>
    1028. 

  1028. </dl>
    1029. 

  1029. </div>
    1030. 

  1030. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">&gt;(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1031. 

  1031. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">&gt;=(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1032. 

  1032. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">&lt;(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1033. 

  1033. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">&lt;=(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1034. 

  1034. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">==(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1035. 

  1035. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">!=(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1036. 

  1036. </pre>
    1037. 

  1037. <div class="variablelist">
    1038. 

  1038. <p class="title"><b></b></p>
    1039. 

  1039. <dl class="variablelist">
    1040. 

  1040. <dt><span class="term">Effects</span></dt>
    1041. 

  1041. <dd><p>
    1042. 

  1042.                 returns the result of applying the operator to <code class="computeroutput"><span class="identifier">object</span><span class="special">(</span><span class="identifier">l</span><span class="special">)</span></code> and <code class="computeroutput"><span class="identifier">object</span><span class="special">(</span><span class="identifier">r</span><span class="special">)</span></code>, respectively, in Python.
    1043. 

  1043.               </p></dd>
    1044. 

  1044. </dl>
    1045. 

  1045. </div>
    1046. 

  1046. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">+(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1047. 

  1047. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">-(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1048. 

  1048. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">*(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1049. 

  1049. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">/(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1050. 

  1050. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">%(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1051. 

  1051. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">&lt;&lt;(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1052. 

  1052. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">&gt;&gt;(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1053. 

  1053. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">&amp;(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1054. 

  1054. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">^(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1055. 

  1055. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">L</span><span class="special">,</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span> <span class="keyword">operator</span><span class="special">|(</span><span class="identifier">L</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1056. 

  1056. </pre>
    1057. 

  1057. <div class="variablelist">
    1058. 

  1058. <p class="title"><b></b></p>
    1059. 

  1059. <dl class="variablelist">
    1060. 

  1060. <dt><span class="term">Effects</span></dt>
    1061. 

  1061. <dd><p>
    1062. 

  1062.                 returns the result of applying the operator to <code class="computeroutput"><span class="identifier">object</span><span class="special">(</span><span class="identifier">l</span><span class="special">)</span></code> and <code class="computeroutput"><span class="identifier">object</span><span class="special">(</span><span class="identifier">r</span><span class="special">)</span></code>, respectively, in Python.
    1063. 

  1063.               </p></dd>
    1064. 

  1064. </dl>
    1065. 

  1065. </div>
    1066. 

  1066. <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">+=(</span><span class="identifier">object</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1067. 

  1067. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">-=(</span><span class="identifier">object</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1068. 

  1068. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">*=(</span><span class="identifier">object</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1069. 

  1069. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">/=(</span><span class="identifier">object</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1070. 

  1070. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">%=(</span><span class="identifier">object</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1071. 

  1071. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">&lt;&lt;=(</span><span class="identifier">object</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">)</span>
    1072. 

  1072. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">&gt;&gt;=(</span><span class="identifier">object</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1073. 

  1073. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">&amp;=(</span><span class="identifier">object</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1074. 

  1074. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">^=(</span><span class="identifier">object</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1075. 

  1075. <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span class="identifier">R</span><span class="special">&gt;</span> <span class="identifier">object</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">|=(</span><span class="identifier">object</span><span class="special">&amp;</span><span class="identifier">l</span><span class="special">,</span><span class="identifier">R</span> <span class="keyword">const</span><span class="special">&amp;</span><span class="identifier">r</span><span class="special">);</span>
    1076. 

  1076. </pre>
    1077. 

  1077. <div class="variablelist">
    1078. 

  1078. <p class="title"><b></b></p>
    1079. 

  1079. <dl class="variablelist">
    1080. 

  1080. <dt><span class="term">Effects</span></dt>
    1081. 

  1081. <dd><p>
    1082. 

  1082.                 assigns to <code class="computeroutput"><span class="identifier">l</span></code> the
    1083. 

  1083.                 result of applying the corresponding Python inplace operator to
    1084. 

  1084.                 <code class="computeroutput"><span class="identifier">l</span></code> and <code class="computeroutput"><span class="identifier">object</span><span class="special">(</span><span class="identifier">r</span><span class="special">)</span></code>,
    1085. 

  1085.                 respectively.
    1086. 

  1086.               </p></dd>
    1087. 

  1087. <dt><span class="term">Returns</span></dt>
    1088. 

  1088. <dd><p>
    1089. 

  1089.                 l
    1090. 

  1090.               </p></dd>
    1091. 

  1091. </dl>
    1092. 

  1092. </div>
    1093. 

  1093. <pre class="programlisting"><span class="keyword">long</span> <span class="identifier">len</span><span class="special">(</span><span class="identifier">object</span> <span class="keyword">const</span><span class="special">&amp;</span> <span class="identifier">obj</span><span class="special">);</span></pre>
    1094. 

  1094. <div class="variablelist">
    1095. 

  1095. <p class="title"><b></b></p>
    1096. 

  1096. <dl class="variablelist">
    1097. 

  1097. <dt><span class="term">Effects</span></dt>
    1098. 

  1098. <dd><p>
    1099. 

  1099.                 <code class="computeroutput"><span class="identifier">PyObject_Length</span><span class="special">(</span><span class="identifier">obj</span><span class="special">.</span><span class="identifier">ptr</span><span class="special">())</span></code>
    1100. 

  1100.               </p></dd>
    1101. 

  1101. <dt><span class="term">Returns</span></dt>
    1102. 

  1102. <dd><p>
    1103. 

  1103.                 <code class="computeroutput"><span class="identifier">len</span><span class="special">()</span></code>
    1104. 

  1104.                 of object.
    1105. 

  1105.               </p></dd>
    1106. 

  1106. </dl>
    1107. 

  1107. </div>
    1108. 

  1108. </div>
    1109. 

  1109. <div class="section">
    1110. 

  1110. <div class="titlepage"><div><div><h3 class="title">
    1111. 

  1111. <a name="object_wrappers.boost_python_object_hpp.example"></a><a class="link" href="boost_python_object_hpp.html#object_wrappers.boost_python_object_hpp.example" title="Example">Example</a>
    1112. 

  1112. </h3></div></div></div>
    1113. 

  1113. <p>
    1114. 

  1114.           Python code:
    1115. 

  1115.         </p>
    1116. 

  1116. <pre class="programlisting"><span class="identifier">def</span> <span class="identifier">sum_items</span><span class="special">(</span><span class="identifier">seq</span><span class="special">):</span>
    1117. 

  1117.    <span class="identifier">result</span> <span class="special">=</span> <span class="number">0</span>
    1118. 

  1118.    <span class="keyword">for</span> <span class="identifier">x</span> <span class="identifier">in</span> <span class="identifier">seq</span><span class="special">:</span>
    1119. 

  1119.       <span class="identifier">result</span> <span class="special">+=</span> <span class="identifier">x</span>
    1120. 

  1120.    <span class="keyword">return</span> <span class="identifier">result</span>
    1121. 

  1121. </pre>
    1122. 

  1122. <p>
    1123. 

  1123.           C++ version
    1124. 

  1124.         </p>
    1125. 

  1125. <pre class="programlisting"><span class="identifier">object</span> <span class="identifier">sum_items</span><span class="special">(</span><span class="identifier">object</span> <span class="identifier">seq</span><span class="special">)</span>
    1126. 

  1126. <span class="special">{</span>
    1127. 

  1127.    <span class="identifier">object</span> <span class="identifier">result</span> <span class="special">=</span> <span class="identifier">object</span><span class="special">(</span><span class="number">0</span><span class="special">);</span>
    1128. 

  1128.    <span class="keyword">for</span> <span class="special">(</span><span class="keyword">int</span> <span class="identifier">i</span> <span class="special">=</span> <span class="number">0</span><span class="special">;</span> <span class="identifier">i</span> <span class="special">&lt;</span> <span class="identifier">len</span><span class="special">(</span><span class="identifier">seq</span><span class="special">);</span> <span class="special">++</span><span class="identifier">i</span><span class="special">)</span>
    1129. 

  1129.       <span class="identifier">result</span> <span class="special">+=</span> <span class="identifier">seq</span><span class="special">[</span><span class="identifier">i</span><span class="special">];</span>
    1130. 

  1130.    <span class="keyword">return</span> <span class="identifier">result</span><span class="special">;</span>
    1131. 

  1131. <span class="special">}</span>
    1132. 

  1132. </pre>
    1133. 

  1133. </div>
    1134. 

  1134. </div>
    1135. 

  1135. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
    1136. 

  1136. <td align="left"></td>
    1137. 

  1137. <td align="right"><div class="copyright-footer">Copyright &#169; 2002-2005, 2015 David Abrahams, Stefan Seefeld<p>
    1138. 

  1138.         Distributed under the Boost Software License, Version 1.0. (See accompanying
    1139. 

  1139.         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>
    1140. 

  1140.       </p>
    1141. 

  1141. </div></td>
    1142. 

  1142. </tr></table>
    1143. 

  1143. <hr>
    1144. 

  1144. <div class="spirit-nav">
    1145. 

  1145. <a accesskey="p" href="boost_python_long_hpp.html"><img src="../../images/prev.png" alt="Prev"></a><a accesskey="u" href="../object_wrappers.html"><img src="../../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../images/home.png" alt="Home"></a><a accesskey="n" href="boost_python_str_hpp.html"><img src="../../images/next.png" alt="Next"></a>
    1146. 

  1146. </div>
    1147. 

  1147. </body>
    1148. 

  1148. </html>
    1149.