<!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: sequence< T > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.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 id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00122.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> </div>
<div class="headertitle">
<h1>sequence< T > Class Template Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="sequence" --><!-- doxytag: inherits="SeqCounter" -->
<p>A template to return a sequence of objects of a specified type.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00181_source.html">counter.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for sequence< T >:</div>
<div class="dyncontent">
<div class="center"><img src="a00431.png" border="0" usemap="#sequence_3_01_t_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="sequence_3_01_t_01_4_inherit__map" id="sequence_3_01_t_01_4_inherit__map">
<area shape="rect" id="node2" href="a00121.html" title="Automatically return a sequence of untyped objects." alt="" coords="20,80,143,107"/><area shape="rect" id="node4" href="a00038.html" title="Automatic integer counting class." alt="" coords="36,5,127,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for sequence< T >:</div>
<div class="dyncontent">
<div class="center"><img src="a00432.png" border="0" usemap="#sequence_3_01_t_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="sequence_3_01_t_01_4_coll__map" id="sequence_3_01_t_01_4_coll__map">
<area shape="rect" id="node2" href="a00121.html" title="Automatically return a sequence of untyped objects." alt="" coords="20,80,143,107"/><area shape="rect" id="node4" href="a00038.html" title="Automatic integer counting class." alt="" coords="36,5,127,32"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
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="a00122.html#a3f77f9827b29f5c43df5d5f847324a2f">get</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return next typed member of the sequence. <a href="#a3f77f9827b29f5c43df5d5f847324a2f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#aa4b6f0a9f4ef0e2174418a67b0fb7f4b">operator T &</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return next typed member of the sequence by casted reference. <a href="#aa4b6f0a9f4ef0e2174418a67b0fb7f4b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a9f15029d9ef7dcae6834914a1e56680e">operator*</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return next typed member of the sequence by pointer reference. <a href="#a9f15029d9ef7dcae6834914a1e56680e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">T & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#a2f5174b827f95f64e7a55d957544c07f">operator[]</a> (unsigned offset)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a specific typed member from the sequence list. <a href="#a2f5174b827f95f64e7a55d957544c07f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00122.html#aec2603c9ca08928254fb0f8050d1bafc">sequence</a> (T *array, unsigned size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a template auto-sequence from a list of typed pointers. <a href="#aec2603c9ca08928254fb0f8050d1bafc"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac9a03c052578b80885beefae5a1805f5"></a><!-- doxytag: member="sequence::get" ref="ac9a03c052578b80885beefae5a1805f5" args="(unsigned idx)" -->
T * </td><td class="memItemRight" valign="bottom"><b>get</b> (unsigned idx)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><h3>template<class T><br/>
class sequence< T ></h3>
<p>A template to return a sequence of objects of a specified type. </p>
<p>This is used to return a different member in a sequence of objects of a specified type during each reference to the sequencer. </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="a00181_source.html#l00155">155</a> of file <a class="el" href="a00181_source.html">counter.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aec2603c9ca08928254fb0f8050d1bafc"></a><!-- doxytag: member="sequence::sequence" ref="aec2603c9ca08928254fb0f8050d1bafc" args="(T *array, unsigned size)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00122.html">sequence</a>< T >::<a class="el" href="a00122.html">sequence</a> </td>
<td>(</td>
<td class="paramtype">T * </td>
<td class="paramname"><em>array</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a template auto-sequence from a list of typed pointers. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">array</td><td>of typed values to sequence on reference. </td></tr>
<tr><td class="paramname">size</td><td>of list of typed values. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00181_source.html#l00167">167</a> of file <a class="el" href="a00181_source.html">counter.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3f77f9827b29f5c43df5d5f847324a2f"></a><!-- doxytag: member="sequence::get" ref="a3f77f9827b29f5c43df5d5f847324a2f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T* <a class="el" href="a00122.html">sequence</a>< T >::get </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>Return next typed member of the sequence. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next typed member of sequence. </dd></dl>
<p>Reimplemented from <a class="el" href="a00121.html#abbcf81005279ff881c543431abb78cbd">SeqCounter</a>.</p>
<p>Definition at line <a class="el" href="a00181_source.html#l00174">174</a> of file <a class="el" href="a00181_source.html">counter.h</a>.</p>
</div>
</div>
<a class="anchor" id="aa4b6f0a9f4ef0e2174418a67b0fb7f4b"></a><!-- doxytag: member="sequence::operator T &" ref="aa4b6f0a9f4ef0e2174418a67b0fb7f4b" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00122.html">sequence</a>< T >::operator T & </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return next typed member of the sequence by casted reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next typed member of sequence. </dd></dl>
<p>Definition at line <a class="el" href="a00181_source.html#l00188">188</a> of file <a class="el" href="a00181_source.html">counter.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9f15029d9ef7dcae6834914a1e56680e"></a><!-- doxytag: member="sequence::operator*" ref="a9f15029d9ef7dcae6834914a1e56680e" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="a00122.html">sequence</a>< T >::operator* </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return next typed member of the sequence by pointer reference. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>next typed member of sequence. </dd></dl>
<p>Reimplemented from <a class="el" href="a00038.html#a1f5b95ad79e15cfda9cd9730c90f4f82">counter</a>.</p>
<p>Definition at line <a class="el" href="a00181_source.html#l00181">181</a> of file <a class="el" href="a00181_source.html">counter.h</a>.</p>
</div>
</div>
<a class="anchor" id="a2f5174b827f95f64e7a55d957544c07f"></a><!-- doxytag: member="sequence::operator[]" ref="a2f5174b827f95f64e7a55d957544c07f" args="(unsigned offset)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T > </div>
<table class="memname">
<tr>
<td class="memname">T& <a class="el" href="a00122.html">sequence</a>< T >::operator[] </td>
<td>(</td>
<td class="paramtype">unsigned </td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return a specific typed member from the sequence list. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>of member to return. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>typed value at the specified offset. </dd></dl>
<p>Definition at line <a class="el" href="a00181_source.html#l00196">196</a> of file <a class="el" href="a00181_source.html">counter.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00181_source.html">counter.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00122.html">sequence</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:48 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
