<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Yate: SignallingCircuitRange Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<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>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceTelEngine.html">TelEngine</a>::<a class="el" href="classTelEngine_1_1SignallingCircuitRange.html">SignallingCircuitRange</a>
</div>
</div>
<div class="contents">
<h1>SignallingCircuitRange Class Reference</h1><!-- doxytag: class="TelEngine::SignallingCircuitRange" --><!-- doxytag: inherits="TelEngine::String" -->A circuit range (set of circuits).
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="yatesig_8h-source.html">yatesig.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for SignallingCircuitRange:</div>
<div class="dynsection">
<p><center><img src="classTelEngine_1_1SignallingCircuitRange.png" usemap="#SignallingCircuitRange_map" border="0" alt=""></center>
<map name="SignallingCircuitRange_map">
<area href="classTelEngine_1_1String.html" alt="String" shape="rect" coords="0,56,140,80">
<area href="classTelEngine_1_1GenObject.html" alt="GenObject" shape="rect" coords="0,0,140,24">
</map>
</div>
<p>
<a href="classTelEngine_1_1SignallingCircuitRange-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#7a2521a98813184a14ed223730238e86">SignallingCircuitRange</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &rangeStr, const char *name=0, int strategy=-1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#1fe9507149e38c5f152db01dd7729ca8">~SignallingCircuitRange</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#b1eb6de2bf3aa228929ab4b40c73507c">count</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const unsigned int * </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#a63a27ff0d07740d95d4aa1cc403f1ab">range</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#c8bb3912a3ce86b15842e79d0b421204">clear</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#8c41af88b0745994f3cfbb65bdd6d52e">operator[]</a> (unsigned int index)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#baccf86f4d2416d2eaa2e17bf4e151ec">set</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &rangeStr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#f1dc6cfc3d0bb0c8ead04cc9523472a5">add</a> (const <a class="el" href="classTelEngine_1_1String.html">String</a> &rangeStr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#c2ff46e27f8ed5f582bcc7a56ab2542b">add</a> (unsigned int *codes, unsigned int len)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#cd219606d5a80e10575150707e36e6d5">add</a> (unsigned int code)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#40dd140b723cebc4360ffda98102b865">remove</a> (unsigned int code)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#b3441f855e87c9b8b9cb0337cda8cfc4">find</a> (unsigned int code)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html#757ca89703a72ac56715edb379958716">destruct</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e7d4822cace85fcfec5bbae5a4ac59cb"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::updateLast" ref="e7d4822cace85fcfec5bbae5a4ac59cb" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>updateLast</b> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d2613a889a3881037b77d8bab23cfc10"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::m_range" ref="d2613a889a3881037b77d8bab23cfc10" args="" -->
<a class="el" href="classTelEngine_1_1DataBlock.html">DataBlock</a> </td><td class="memItemRight" valign="bottom"><b>m_range</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3ead989ffdf27edd0a19bd1bf3449e2a"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::m_count" ref="3ead989ffdf27edd0a19bd1bf3449e2a" args="" -->
unsigned int </td><td class="memItemRight" valign="bottom"><b>m_count</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bf30398377f174e0a6bc7ca8391c95bb"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::m_last" ref="bf30398377f174e0a6bc7ca8391c95bb" args="" -->
unsigned int </td><td class="memItemRight" valign="bottom"><b>m_last</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="05f4aaa508e605c1ce2debaa388ffab4"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::m_strategy" ref="05f4aaa508e605c1ce2debaa388ffab4" args="" -->
int </td><td class="memItemRight" valign="bottom"><b>m_strategy</b></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d9ee495e1ff30ba204ad8b7dbc22665d"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::m_used" ref="d9ee495e1ff30ba204ad8b7dbc22665d" args="" -->
unsigned int </td><td class="memItemRight" valign="bottom"><b>m_used</b></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b730cede227171a97a1344227e4fd9cd"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::SignallingCircuitGroup" ref="b730cede227171a97a1344227e4fd9cd" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>SignallingCircuitGroup</b></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A circuit range (set of circuits).
<p>
Keeps a range (set) of circuits. The circuit codes contained within a range may not be contiguous. See <a class="el" href="classTelEngine_1_1SignallingUtils.html#bb7f15e357ba2d442c2cdac5c21a8fb8">SignallingUtils::parseUIntArray()</a> for the format of the string ranges this object can be built from <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="7a2521a98813184a14ed223730238e86"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::SignallingCircuitRange" ref="7a2521a98813184a14ed223730238e86" args="(const String &rangeStr, const char *name=0, int strategy=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classTelEngine_1_1SignallingCircuitRange.html">SignallingCircuitRange</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>rangeStr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>strategy</em> = <code>-1</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rangeStr</em> </td><td><a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> used to build this range </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Range name </td></tr>
<tr><td valign="top"></td><td valign="top"><em>strategy</em> </td><td>Strategy used to allocate circuits from this range </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1fe9507149e38c5f152db01dd7729ca8"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::~SignallingCircuitRange" ref="1fe9507149e38c5f152db01dd7729ca8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~<a class="el" href="classTelEngine_1_1SignallingCircuitRange.html">SignallingCircuitRange</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destructor
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="cd219606d5a80e10575150707e36e6d5"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::add" ref="cd219606d5a80e10575150707e36e6d5" args="(unsigned int code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void add </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>code</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add a circuit code to this range <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>The circuit code to add </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="c2ff46e27f8ed5f582bcc7a56ab2542b"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::add" ref="c2ff46e27f8ed5f582bcc7a56ab2542b" args="(unsigned int *codes, unsigned int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void add </td>
<td>(</td>
<td class="paramtype">unsigned int * </td>
<td class="paramname"> <em>codes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add an array of circuit codes to this range <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>codes</em> </td><td>The array to add </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>The array's length </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f1dc6cfc3d0bb0c8ead04cc9523472a5"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::add" ref="f1dc6cfc3d0bb0c8ead04cc9523472a5" args="(const String &rangeStr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool add </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>rangeStr</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add codes to this range from a string <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rangeStr</em> </td><td><a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> containing the codes to be added to this range </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the string has invalid format </dd></dl>
</div>
</div><p>
<a class="anchor" name="c8bb3912a3ce86b15842e79d0b421204"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::clear" ref="c8bb3912a3ce86b15842e79d0b421204" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the pointer to the circuit codes array <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the circuit codes array or 0 </dd></dl>
<p>Reimplemented from <a class="el" href="classTelEngine_1_1String.html#c8bb3912a3ce86b15842e79d0b421204">String</a>.</p>
</div>
</div><p>
<a class="anchor" name="b1eb6de2bf3aa228929ab4b40c73507c"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::count" ref="b1eb6de2bf3aa228929ab4b40c73507c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int count </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of circuits contained by this range <dl class="return" compact><dt><b>Returns:</b></dt><dd>The number of circuits contained by this range </dd></dl>
</div>
</div><p>
<a class="anchor" name="757ca89703a72ac56715edb379958716"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::destruct" ref="757ca89703a72ac56715edb379958716" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void destruct </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Release memory
<p>Reimplemented from <a class="el" href="classTelEngine_1_1GenObject.html#757ca89703a72ac56715edb379958716">GenObject</a>.</p>
<p>References <a class="el" href="yateclass_8h-source.html#l00650">TelEngine::destruct()</a>.</p>
</div>
</div><p>
<a class="anchor" name="b3441f855e87c9b8b9cb0337cda8cfc4"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::find" ref="b3441f855e87c9b8b9cb0337cda8cfc4" args="(unsigned int code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool find </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>code</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a circuit code is within this range <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>The circuit code to find </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if found </dd></dl>
</div>
</div><p>
<a class="anchor" name="8c41af88b0745994f3cfbb65bdd6d52e"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::operator[]" ref="8c41af88b0745994f3cfbb65bdd6d52e" args="(unsigned int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int operator[] </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Indexing operator <dl compact><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>The index in the array to retreive </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The code at the given index </dd></dl>
</div>
</div><p>
<a class="anchor" name="a63a27ff0d07740d95d4aa1cc403f1ab"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::range" ref="a63a27ff0d07740d95d4aa1cc403f1ab" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const unsigned int* range </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the pointer to the circuit codes array <dl class="return" compact><dt><b>Returns:</b></dt><dd>Pointer to the circuit codes array or 0 </dd></dl>
</div>
</div><p>
<a class="anchor" name="40dd140b723cebc4360ffda98102b865"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::remove" ref="40dd140b723cebc4360ffda98102b865" args="(unsigned int code)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void remove </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>code</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a circuit code from this range <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>code</em> </td><td>The circuit code to remove </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="baccf86f4d2416d2eaa2e17bf4e151ec"></a><!-- doxytag: member="TelEngine::SignallingCircuitRange::set" ref="baccf86f4d2416d2eaa2e17bf4e151ec" args="(const String &rangeStr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classTelEngine_1_1String.html">String</a> & </td>
<td class="paramname"> <em>rangeStr</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set this range from a string <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>rangeStr</em> </td><td><a class="el" href="classTelEngine_1_1String.html" title="A C-style string handling class.">String</a> used to (re)build this range </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>False if the string has invalid format </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="yatesig_8h-source.html">yatesig.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Dec 7 21:36:13 2008 for Yate by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
eeacaa4eb55fa544d622989e42fc27b1
>
files
>
548
