src/native_client_sdk/doc_generated/pepper_stable/cpp/classpp_1_1_var_array.html

   1 {{+bindTo:partials.standard_nacl_api}}
   2 <h1>pp::VarArray Class Reference</h1>
   3 <div id="doxygen-ref">
   4 {{- dummy div to appease doxygen -}}
   5   <div>
   6 <!-- Generated by Doxygen 1.7.6.1 -->
   7
   8
   9
  10 </div>
  11 <!--header-->
  12 <div class="contents">
  13 <!-- doxytag: class="pp::VarArray" --><!-- doxytag: inherits="pp::Var" --><div class="dynheader">
  14 Inheritance diagram for pp::VarArray:</div>
  15 <div class="dyncontent">
  16 <div class="center"><img src="classpp_1_1_var_array__inherit__graph.png" border="0" usemap="#pp_1_1_var_array_inherit__map" alt="Inheritance graph" /></div>
  17 <map name="pp_1_1_var_array_inherit__map" id="pp_1_1_var_array_inherit__map">
  18 <area shape="rect" id="node2" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page." alt="" coords="23,5,89,32"></area></map>
  19 <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
  20 <p><a href="classpp_1_1_var_array-members.html">List of all members.</a></p>
  21 <h2>
  22 Public Member Functions</h2><table class="memberdecls">
  23
  24 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#a780daccc2dc02eac8a52b3c6acf245ed">VarArray</a> ()</td></tr>
  25 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#a3aabef79f9d8af79a4ef5dda73a09c05">VarArray</a> (const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;var)</td></tr>
  26 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#abb66ecc726d9aca28bd4a430a391a5d3">VarArray</a> (const PP_Var &amp;var)</td></tr>
  27 <tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#a839cc2aa7b5a4698f3a11214f76e56c0">VarArray</a> (const <a class="el" href="classpp_1_1_var_array.html">VarArray</a> &amp;other)</td></tr>
  28 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#a667aca2cad8fd48469dab1228f479284">~VarArray</a> ()</td></tr>
  29 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var_array.html">VarArray</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#a5acb01cba7823e5b4096a3d1c1cf31be">operator=</a> (const <a class="el" href="classpp_1_1_var_array.html">VarArray</a> &amp;other)</td></tr>
  30 <tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#aeb98c95929dd46d1f64eba13db724154">operator=</a> (const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;other)</td></tr>
  31 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpp_1_1_var.html">Var</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#a61f3bd9357da964824bc3dfbc7715b12">Get</a> (uint32_t index) const </td></tr>
  32 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#a6769d254d64ca6f0e5a5321ad9158d89">Set</a> (uint32_t index, const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;value)</td></tr>
  33 <tr><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#afaa8006ed2c7fa4fb99a6d9d96b91f5a">GetLength</a> () const </td></tr>
  34 <tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpp_1_1_var_array.html#a6d37da10169a4e9f66152d74231694b9">SetLength</a> (uint32_t length)</td></tr>
  35 </table>
  36 <hr /><h2>Constructor &amp; Destructor Documentation</h2>
  37 <a class="anchor" id="a780daccc2dc02eac8a52b3c6acf245ed"></a><!-- doxytag: member="pp::VarArray::VarArray" ref="a780daccc2dc02eac8a52b3c6acf245ed" args="()" -->
  38 <div class="memitem">
  39 <div class="memproto">
  40 <table class="memname">
  41 <tr>
  42 <td class="memname"><a class="el" href="classpp_1_1_var_array.html#a780daccc2dc02eac8a52b3c6acf245ed">pp::VarArray::VarArray</a> </td>
  43 <td>(</td>
  44 <td class="paramname"></td><td>)</td>
  45 <td></td>
  46 </tr>
  47 </table>
  48 </div>
  49 <div class="memdoc">
  50 <p>Constructs a new array var. </p>
  51 </div>
  52 </div>
  53 <a class="anchor" id="a3aabef79f9d8af79a4ef5dda73a09c05"></a><!-- doxytag: member="pp::VarArray::VarArray" ref="a3aabef79f9d8af79a4ef5dda73a09c05" args="(const Var &amp;var)" -->
  54 <div class="memitem">
  55 <div class="memproto">
  56 <table class="memname">
  57 <tr>
  58 <td class="memname"><a class="el" href="classpp_1_1_var_array.html#a780daccc2dc02eac8a52b3c6acf245ed">pp::VarArray::VarArray</a> </td>
  59 <td>(</td>
  60 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
  61 <td class="paramname"><em>var</em></td><td>)</td>
  62 <td><code> [explicit]</code></td>
  63 </tr>
  64 </table>
  65 </div>
  66 <div class="memdoc">
  67 <p>Constructs a <code><a class="el" href="classpp_1_1_var_array.html">VarArray</a></code> given a var for which <a class="el" href="classpp_1_1_var.html#a7a28894a77f9d69d1a4b0272bf80d657" title="This function determines if this Var is an array.">is_array()</a> is true. </p>
  68 <p>This will refer to the same array var, but allow you to access methods specific to arrays.</p>
  69 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  70 <table class="params">
  71 <tr><td class="paramdir">[in]</td><td class="paramname">var</td><td>An array var. </td></tr>
  72 </table>
  73 </dd>
  74 </dl>
  75 </div>
  76 </div>
  77 <a class="anchor" id="abb66ecc726d9aca28bd4a430a391a5d3"></a><!-- doxytag: member="pp::VarArray::VarArray" ref="abb66ecc726d9aca28bd4a430a391a5d3" args="(const PP_Var &amp;var)" -->
  78 <div class="memitem">
  79 <div class="memproto">
  80 <table class="memname">
  81 <tr>
  82 <td class="memname"><a class="el" href="classpp_1_1_var_array.html#a780daccc2dc02eac8a52b3c6acf245ed">pp::VarArray::VarArray</a> </td>
  83 <td>(</td>
  84 <td class="paramtype">const PP_Var &amp;&#160;</td>
  85 <td class="paramname"><em>var</em></td><td>)</td>
  86 <td><code> [explicit]</code></td>
  87 </tr>
  88 </table>
  89 </div>
  90 <div class="memdoc">
  91 <p>Constructs a <code><a class="el" href="classpp_1_1_var_array.html">VarArray</a></code> given a <code>PP_Var</code> of type PP_VARTYPE_ARRAY. </p>
  92 <dl class="params"><dt><b>Parameters:</b></dt><dd>
  93 <table class="params">
  94 <tr><td class="paramdir">[in]</td><td class="paramname">var</td><td>A <code>PP_Var</code> of type PP_VARTYPE_ARRAY. </td></tr>
  95 </table>
  96 </dd>
  97 </dl>
  98 </div>
  99 </div>
 100 <a class="anchor" id="a839cc2aa7b5a4698f3a11214f76e56c0"></a><!-- doxytag: member="pp::VarArray::VarArray" ref="a839cc2aa7b5a4698f3a11214f76e56c0" args="(const VarArray &amp;other)" -->
 101 <div class="memitem">
 102 <div class="memproto">
 103 <table class="memname">
 104 <tr>
 105 <td class="memname"><a class="el" href="classpp_1_1_var_array.html#a780daccc2dc02eac8a52b3c6acf245ed">pp::VarArray::VarArray</a> </td>
 106 <td>(</td>
 107 <td class="paramtype">const <a class="el" href="classpp_1_1_var_array.html">VarArray</a> &amp;&#160;</td>
 108 <td class="paramname"><em>other</em></td><td>)</td>
 109 <td></td>
 110 </tr>
 111 </table>
 112 </div>
 113 <div class="memdoc">
 114 <p>Copy constructor. </p>
 115 </div>
 116 </div>
 117 <a class="anchor" id="a667aca2cad8fd48469dab1228f479284"></a><!-- doxytag: member="pp::VarArray::~VarArray" ref="a667aca2cad8fd48469dab1228f479284" args="()" -->
 118 <div class="memitem">
 119 <div class="memproto">
 120 <table class="memname">
 121 <tr>
 122 <td class="memname">virtual <a class="el" href="classpp_1_1_var_array.html#a667aca2cad8fd48469dab1228f479284">pp::VarArray::~VarArray</a> </td>
 123 <td>(</td>
 124 <td class="paramname"></td><td>)</td>
 125 <td><code> [virtual]</code></td>
 126 </tr>
 127 </table>
 128 </div>
 129 <div class="memdoc">
 130 </div>
 131 </div>
 132 <hr /><h2>Member Function Documentation</h2>
 133 <a class="anchor" id="a61f3bd9357da964824bc3dfbc7715b12"></a><!-- doxytag: member="pp::VarArray::Get" ref="a61f3bd9357da964824bc3dfbc7715b12" args="(uint32_t index) const " -->
 134 <div class="memitem">
 135 <div class="memproto">
 136 <table class="memname">
 137 <tr>
 138 <td class="memname"><a class="el" href="classpp_1_1_var.html">Var</a> <a class="el" href="classpp_1_1_var_array.html#a61f3bd9357da964824bc3dfbc7715b12">pp::VarArray::Get</a> </td>
 139 <td>(</td>
 140 <td class="paramtype">uint32_t&#160;</td>
 141 <td class="paramname"><em>index</em></td><td>)</td>
 142 <td> const</td>
 143 </tr>
 144 </table>
 145 </div>
 146 <div class="memdoc">
 147 <p>Gets an element from the array. </p>
 148 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 149 <table class="params">
 150 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>An index indicating which element to return.</td></tr>
 151 </table>
 152 </dd>
 153 </dl>
 154 <dl class="return"><dt><b>Returns:</b></dt><dd>The element at the specified position. If <code>index</code> is larger than or equal to the array length, an undefined var is returned. </dd></dl>
 155 </div>
 156 </div>
 157 <a class="anchor" id="afaa8006ed2c7fa4fb99a6d9d96b91f5a"></a><!-- doxytag: member="pp::VarArray::GetLength" ref="afaa8006ed2c7fa4fb99a6d9d96b91f5a" args="() const " -->
 158 <div class="memitem">
 159 <div class="memproto">
 160 <table class="memname">
 161 <tr>
 162 <td class="memname">uint32_t <a class="el" href="classpp_1_1_var_array.html#afaa8006ed2c7fa4fb99a6d9d96b91f5a">pp::VarArray::GetLength</a> </td>
 163 <td>(</td>
 164 <td class="paramname"></td><td>)</td>
 165 <td> const</td>
 166 </tr>
 167 </table>
 168 </div>
 169 <div class="memdoc">
 170 <p>Gets the array length. </p>
 171 <dl class="return"><dt><b>Returns:</b></dt><dd>The array length. </dd></dl>
 172 </div>
 173 </div>
 174 <a class="anchor" id="a5acb01cba7823e5b4096a3d1c1cf31be"></a><!-- doxytag: member="pp::VarArray::operator=" ref="a5acb01cba7823e5b4096a3d1c1cf31be" args="(const VarArray &amp;other)" -->
 175 <div class="memitem">
 176 <div class="memproto">
 177 <table class="memname">
 178 <tr>
 179 <td class="memname"><a class="el" href="classpp_1_1_var_array.html">VarArray</a>&amp; pp::VarArray::operator= </td>
 180 <td>(</td>
 181 <td class="paramtype">const <a class="el" href="classpp_1_1_var_array.html">VarArray</a> &amp;&#160;</td>
 182 <td class="paramname"><em>other</em></td><td>)</td>
 183 <td></td>
 184 </tr>
 185 </table>
 186 </div>
 187 <div class="memdoc">
 188 <p>Assignment operator. </p>
 189 </div>
 190 </div>
 191 <a class="anchor" id="aeb98c95929dd46d1f64eba13db724154"></a><!-- doxytag: member="pp::VarArray::operator=" ref="aeb98c95929dd46d1f64eba13db724154" args="(const Var &amp;other)" -->
 192 <div class="memitem">
 193 <div class="memproto">
 194 <table class="memname">
 195 <tr>
 196 <td class="memname">virtual <a class="el" href="classpp_1_1_var.html">Var</a>&amp; pp::VarArray::operator= </td>
 197 <td>(</td>
 198 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
 199 <td class="paramname"><em>other</em></td><td>)</td>
 200 <td><code> [virtual]</code></td>
 201 </tr>
 202 </table>
 203 </div>
 204 <div class="memdoc">
 205 <p>The <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code> assignment operator is overridden here so that we can check for assigning a non-array var to a <code><a class="el" href="classpp_1_1_var_array.html">VarArray</a></code>. </p>
 206 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 207 <table class="params">
 208 <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>The array var to be assigned.</td></tr>
 209 </table>
 210 </dd>
 211 </dl>
 212 <dl class="return"><dt><b>Returns:</b></dt><dd>The resulting <code><a class="el" href="classpp_1_1_var_array.html">VarArray</a></code> (as a <code><a class="el" href="classpp_1_1_var.html" title="A generic type used for passing data types between the module and the page.">Var</a></code>&amp;). </dd></dl>
 213 <p>Reimplemented from <a class="el" href="classpp_1_1_var.html#a65601024610f1625c9945acb8725d7c4">pp::Var</a>.</p>
 214 </div>
 215 </div>
 216 <a class="anchor" id="a6769d254d64ca6f0e5a5321ad9158d89"></a><!-- doxytag: member="pp::VarArray::Set" ref="a6769d254d64ca6f0e5a5321ad9158d89" args="(uint32_t index, const Var &amp;value)" -->
 217 <div class="memitem">
 218 <div class="memproto">
 219 <table class="memname">
 220 <tr>
 221 <td class="memname">bool <a class="el" href="classpp_1_1_var_array.html#a6769d254d64ca6f0e5a5321ad9158d89">pp::VarArray::Set</a> </td>
 222 <td>(</td>
 223 <td class="paramtype">uint32_t&#160;</td>
 224 <td class="paramname"><em>index</em>, </td>
 225 </tr>
 226 <tr>
 227 <td class="paramkey"></td>
 228 <td></td>
 229 <td class="paramtype">const <a class="el" href="classpp_1_1_var.html">Var</a> &amp;&#160;</td>
 230 <td class="paramname"><em>value</em>&#160;</td>
 231 </tr>
 232 <tr>
 233 <td></td>
 234 <td>)</td>
 235 <td></td><td></td>
 236 </tr>
 237 </table>
 238 </div>
 239 <div class="memdoc">
 240 <p>Sets the value of an element in the array. </p>
 241 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 242 <table class="params">
 243 <tr><td class="paramdir">[in]</td><td class="paramname">index</td><td>An index indicating which element to modify. If <code>index</code> is larger than or equal to the array length, the length is updated to be <code>index</code> + 1. Any position in the array that hasn't been set before is set to undefined, i.e., <code>PP_Var</code> of type <code>PP_VARTYPE_UNDEFINED</code>. </td></tr>
 244 <tr><td class="paramdir">[in]</td><td class="paramname">value</td><td>The value to set.</td></tr>
 245 </table>
 246 </dd>
 247 </dl>
 248 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>bool</code> indicating whether the operation succeeds. </dd></dl>
 249 </div>
 250 </div>
 251 <a class="anchor" id="a6d37da10169a4e9f66152d74231694b9"></a><!-- doxytag: member="pp::VarArray::SetLength" ref="a6d37da10169a4e9f66152d74231694b9" args="(uint32_t length)" -->
 252 <div class="memitem">
 253 <div class="memproto">
 254 <table class="memname">
 255 <tr>
 256 <td class="memname">bool <a class="el" href="classpp_1_1_var_array.html#a6d37da10169a4e9f66152d74231694b9">pp::VarArray::SetLength</a> </td>
 257 <td>(</td>
 258 <td class="paramtype">uint32_t&#160;</td>
 259 <td class="paramname"><em>length</em></td><td>)</td>
 260 <td></td>
 261 </tr>
 262 </table>
 263 </div>
 264 <div class="memdoc">
 265 <p>Sets the array length. </p>
 266 <dl class="params"><dt><b>Parameters:</b></dt><dd>
 267 <table class="params">
 268 <tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The new array length. If <code>length</code> is smaller than its current value, the array is truncated to the new length; any elements that no longer fit are removed. If <code>length</code> is larger than its current value, undefined vars are appended to increase the array to the specified length.</td></tr>
 269 </table>
 270 </dd>
 271 </dl>
 272 <dl class="return"><dt><b>Returns:</b></dt><dd>A <code>bool</code> indicating whether the operation succeeds. </dd></dl>
 273 </div>
 274 </div>
 275 <hr />The documentation for this class was generated from the following file:<ul>
 276 <li><a class="el" href="var__array_8h.html">var_array.h</a></li>
 277 </ul>
 278 </div><!-- contents -->
 279 </div>
 280 {{/partials.standard_nacl_api}}