<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>ucommon: ucommon::vectorbuf< T, S > Class Template Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="main.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li><a href="classes.html"><span>Data Structure Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Data Fields</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="a00208.html">ucommon</a>::<a class="el" href="a00173.html">vectorbuf</a> </div> </div> <div class="contents"> <h1>ucommon::vectorbuf< T, S > Class Template Reference</h1><!-- doxytag: class="ucommon::vectorbuf" --><!-- doxytag: inherits="ucommon::MemVector" --> <p>Allocated vector list of a specified type. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="a00206_source.html">vector.h</a>></code></p> <div class="dynheader"> Inheritance diagram for ucommon::vectorbuf< T, S >:</div> <div class="dynsection"> <div class="center"><img src="a00568.png" border="0" usemap="#ucommon_1_1vectorbuf_3_01_t_00_01_s_01_4_inherit__map" alt="Inheritance graph"/></div> <map name="ucommon_1_1vectorbuf_3_01_t_00_01_s_01_4_inherit__map" id="ucommon_1_1vectorbuf_3_01_t_00_01_s_01_4_inherit__map"> <area shape="rect" id="node2" href="a00083.html" title="Vector with fixed size member list." alt="" coords="45,80,248,107"/><area shape="rect" id="node4" href="a00172.html" title="A managed vector for generic object pointers." alt="" coords="61,5,232,32"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <div class="dynheader"> Collaboration diagram for ucommon::vectorbuf< T, S >:</div> <div class="dynsection"> <div class="center"><img src="a00569.png" border="0" usemap="#ucommon_1_1vectorbuf_3_01_t_00_01_s_01_4_coll__map" alt="Collaboration graph"/></div> <map name="ucommon_1_1vectorbuf_3_01_t_00_01_s_01_4_coll__map" id="ucommon_1_1vectorbuf_3_01_t_00_01_s_01_4_coll__map"> <area shape="rect" id="node2" href="a00083.html" title="Vector with fixed size member list." alt="" coords="45,80,248,107"/><area shape="rect" id="node4" href="a00172.html" title="A managed vector for generic object pointers." alt="" coords="61,5,232,32"/></map> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#a4929817365c1645638bee4586448b347">begin</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the first typed object pointer contained in the fixed vector. <a href="#a4929817365c1645638bee4586448b347"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#a4694485bebbd2be1bbab759a49ba31ec">end</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the last typed object pointer contained in the fixed vector. <a href="#a4694485bebbd2be1bbab759a49ba31ec"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#ab75648bdb56406c3d844b24fcdcad893">get</a> (int index)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get object pointer of specified type from fixed vector. <a href="#ab75648bdb56406c3d844b24fcdcad893"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">T * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#ae6135fd1a0ea5fe11a5de766f565a9e9">operator()</a> (vectorsize_t position)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a typed member of the fixed vector directly. <a href="#ae6135fd1a0ea5fe11a5de766f565a9e9"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00172.html">Vector</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#a14d659be8f147ef9abb5f3cc4592dc25">operator+</a> (<a class="el" href="a00172.html">Vector</a> &vector)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Concatenate fixed typed vector in an expression. <a href="#a14d659be8f147ef9abb5f3cc4592dc25"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#ac0626b5bcedf3b8997f6bfaeab24eae1">operator[]</a> (int index)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer from the vector by array reference. <a href="#ac0626b5bcedf3b8997f6bfaeab24eae1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa14fb6264009bc69fb218cc078906239"></a><!-- doxytag: member="ucommon::vectorbuf::vectorbuf" ref="aa14fb6264009bc69fb218cc078906239" args="()" --> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00173.html#aa14fb6264009bc69fb218cc078906239">vectorbuf</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct fixed sized vector object in heap or stack. <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <h3>template<typename T, vectorsize_t S><br/> class ucommon::vectorbuf< T, S ></h3> <p>Allocated vector list of a specified type. </p> <p>This analogous to the stringbuf class and allows one to create a vector with it's member list as a single object that can live in the heap or that can be created at once and used as a auto variable. </p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl> <p>Definition at line <a class="el" href="a00206_source.html#l00686">686</a> of file <a class="el" href="a00206_source.html">vector.h</a>.</p> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a4929817365c1645638bee4586448b347"></a><!-- doxytag: member="ucommon::vectorbuf::begin" ref="a4929817365c1645638bee4586448b347" args="(void)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T , vectorsize_t S> </div> <table class="memname"> <tr> <td class="memname">T* <a class="el" href="a00173.html">ucommon::vectorbuf</a>< T, S >::begin </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the first typed object pointer contained in the fixed vector. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>first typed object pointer. </dd></dl> <p>Definition at line <a class="el" href="a00206_source.html#l00720">720</a> of file <a class="el" href="a00206_source.html">vector.h</a>.</p> </div> </div> <a class="anchor" id="a4694485bebbd2be1bbab759a49ba31ec"></a><!-- doxytag: member="ucommon::vectorbuf::end" ref="a4694485bebbd2be1bbab759a49ba31ec" args="(void)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T , vectorsize_t S> </div> <table class="memname"> <tr> <td class="memname">T* <a class="el" href="a00173.html">ucommon::vectorbuf</a>< T, S >::end </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get the last typed object pointer contained in the fixed vector. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>last typed object pointer. </dd></dl> <p>Definition at line <a class="el" href="a00206_source.html#l00727">727</a> of file <a class="el" href="a00206_source.html">vector.h</a>.</p> </div> </div> <a class="anchor" id="ab75648bdb56406c3d844b24fcdcad893"></a><!-- doxytag: member="ucommon::vectorbuf::get" ref="ab75648bdb56406c3d844b24fcdcad893" args="(int index)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T , vectorsize_t S> </div> <table class="memname"> <tr> <td class="memname">T* <a class="el" href="a00173.html">ucommon::vectorbuf</a>< T, S >::get </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>index</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Get object pointer of specified type from fixed vector. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>of typed member to return, < 0 to use from end of list. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>typed object pointer of member. </dd></dl> <p>Definition at line <a class="el" href="a00206_source.html#l00702">702</a> of file <a class="el" href="a00206_source.html">vector.h</a>.</p> </div> </div> <a class="anchor" id="ae6135fd1a0ea5fe11a5de766f565a9e9"></a><!-- doxytag: member="ucommon::vectorbuf::operator()" ref="ae6135fd1a0ea5fe11a5de766f565a9e9" args="(vectorsize_t position)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T , vectorsize_t S> </div> <table class="memname"> <tr> <td class="memname">T* <a class="el" href="a00173.html">ucommon::vectorbuf</a>< T, S >::operator() </td> <td>(</td> <td class="paramtype">vectorsize_t </td> <td class="paramname"> <em>position</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Retrieve a typed member of the fixed vector directly. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>position</em> </td><td>to retrieve object from. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>typed object pointer retrieved from vector. </dd></dl> <p>Reimplemented from <a class="el" href="a00172.html#a038501602335e5b2b63b2a087717a3ce">ucommon::Vector</a>.</p> <p>Definition at line <a class="el" href="a00206_source.html#l00713">713</a> of file <a class="el" href="a00206_source.html">vector.h</a>.</p> </div> </div> <a class="anchor" id="a14d659be8f147ef9abb5f3cc4592dc25"></a><!-- doxytag: member="ucommon::vectorbuf::operator+" ref="a14d659be8f147ef9abb5f3cc4592dc25" args="(Vector &vector)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T , vectorsize_t S> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="a00172.html">Vector</a>& <a class="el" href="a00173.html">ucommon::vectorbuf</a>< T, S >::operator+ </td> <td>(</td> <td class="paramtype"><a class="el" href="a00172.html">Vector</a> & </td> <td class="paramname"> <em>vector</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Concatenate fixed typed vector in an expression. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>vector</em> </td><td>to concatenate. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>effective object to continue in expression. </dd></dl> <p>Reimplemented from <a class="el" href="a00172.html#a33194c758e5d3a85a08b8e45f90d09ed">ucommon::Vector</a>.</p> <p>Definition at line <a class="el" href="a00206_source.html#l00735">735</a> of file <a class="el" href="a00206_source.html">vector.h</a>.</p> <p><div class="dynheader"> Here is the call graph for this function:</div> <div class="dynsection"> <div class="center"><img src="a00173_a14d659be8f147ef9abb5f3cc4592dc25_cgraph.png" border="0" usemap="#a00173_a14d659be8f147ef9abb5f3cc4592dc25_cgraph_map" alt=""></div> <map name="a00173_a14d659be8f147ef9abb5f3cc4592dc25_cgraph_map" id="a00173_a14d659be8f147ef9abb5f3cc4592dc25_cgraph"> <area shape="rect" id="node3" href="a00208.html#a0a43af474b84d87df26aa4998bcebb02" title="Add a linked object onto a stack of linked objects." alt="" coords="367,5,508,32"/></map> </div> </p> </div> </div> <a class="anchor" id="ac0626b5bcedf3b8997f6bfaeab24eae1"></a><!-- doxytag: member="ucommon::vectorbuf::operator[]" ref="ac0626b5bcedf3b8997f6bfaeab24eae1" args="(int index)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename T , vectorsize_t S> </div> <table class="memname"> <tr> <td class="memname">T& <a class="el" href="a00173.html">ucommon::vectorbuf</a>< T, S >::operator[] </td> <td>(</td> <td class="paramtype">int </td> <td class="paramname"> <em>index</em></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Return a pointer from the vector by array reference. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>of vector member pointer to return. </td></tr> </table> </dd> </dl> <p>Reimplemented from <a class="el" href="a00172.html#ae4c14b2123c4b07eab1e7bdfc68728a2">ucommon::Vector</a>.</p> <p>Definition at line <a class="el" href="a00206_source.html#l00705">705</a> of file <a class="el" href="a00206_source.html">vector.h</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>ucommon/<a class="el" href="a00206_source.html">vector.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Thu Jul 14 16:40:12 2011 for ucommon by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>