Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_c_shared_intermediator.html
Week 32 contribution of PDK documentation content. See release notes for details. Fixes bug Bug 3582
<!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>TB9.2 Example Applications: CSharedIntermediator Class 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.2 -->
<div class="contents">
<h1>CSharedIntermediator Class Reference</h1><!-- doxytag: class="CSharedIntermediator" -->
<p><a href="class_c_shared_intermediator-members.html">List of all members.</a></p>
<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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#a11fb8f1e5489e3762e75f257b937e014">~CSharedIntermediator</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#a8c4ec9ad89fd0b9168c50472fa3e1ec7">AddBluetoothInfoL</a> (<a class="el" href="class_t_bluetooth_info.html">TBluetoothInfo</a> &aBtInfoElement)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#a22888d5681085c1321e3e3890bc0c780">ResetArray</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#accce976d88b563b511fee0754aac51d7">GetAddress</a> (TDes &aAddress, TInt aIndex)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#a90e24ea996df35031bcee2bd575abbcb">SetStopSearching</a> (bool aStopSearching)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TBool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#a8d00c726b3de0ad952e32d0ed9a89364">StopSearching</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#a2914f06c89de0dc1c1477b5f3f0a73fb">BTRefreshTimerPtr</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#ac22c0341f159855b73e858050d6114b1">SetBTRefreshTimerPtr</a> (<a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> *aTimer)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_c_device_list_container.html">CDeviceListContainer</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#a1691ecc4482d77cd453f621163947d3c">DeviceListContainer</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#a9760bf8202ebb31c85f1a81fe48d2575">SetRefreshTimerInitlVal</a> (TInt aRefreshTime)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">TInt </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#a028d5958e4503d319b594412bf118a3d">RefreshTimerInitlVal</a> ()</td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_shared_intermediator.html">CSharedIntermediator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#a57ac0686f87c29e49149a38809b990f4">NewL</a> (<a class="el" href="class_c_device_list_container.html">CDeviceListContainer</a> *aView)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_c_shared_intermediator.html">CSharedIntermediator</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_shared_intermediator.html#adf971a6fd4ffe1bc850a028a975f0cbc">NewLC</a> (<a class="el" href="class_c_device_list_container.html">CDeviceListContainer</a> *aView)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>CSharedInterMediator Transmits data between main program and thread one, Thread one reads commands, which are given in UI (main program). </p>
<p>Definition at line <a class="el" href="sharedintermediator_8h_source.html#l00025">25</a> of file <a class="el" href="sharedintermediator_8h_source.html">sharedintermediator.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a11fb8f1e5489e3762e75f257b937e014"></a><!-- doxytag: member="CSharedIntermediator::~CSharedIntermediator" ref="a11fb8f1e5489e3762e75f257b937e014" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CSharedIntermediator::~CSharedIntermediator </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#a11fb8f1e5489e3762e75f257b937e014">~CSharedIntermediator()</a></p>
<p>discussion Destructor. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00037">37</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a57ac0686f87c29e49149a38809b990f4"></a><!-- doxytag: member="CSharedIntermediator::NewL" ref="a57ac0686f87c29e49149a38809b990f4" args="(CDeviceListContainer *aView)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_shared_intermediator.html">CSharedIntermediator</a> * CSharedIntermediator::NewL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_device_list_container.html">CDeviceListContainer</a> * </td>
<td class="paramname"> <em>aView</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#a57ac0686f87c29e49149a38809b990f4">NewL()</a></p>
<p>discussion Create new <a class="el" href="class_c_shared_intermediator.html">CSharedIntermediator</a> object. param aView is a UI's container. return a pointer to the created instance of <a class="el" href="class_c_shared_intermediator.html">CSharedIntermediator</a>. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00047">47</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adf971a6fd4ffe1bc850a028a975f0cbc"></a><!-- doxytag: member="CSharedIntermediator::NewLC" ref="adf971a6fd4ffe1bc850a028a975f0cbc" args="(CDeviceListContainer *aView)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_shared_intermediator.html">CSharedIntermediator</a> * CSharedIntermediator::NewLC </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_device_list_container.html">CDeviceListContainer</a> * </td>
<td class="paramname"> <em>aView</em></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#adf971a6fd4ffe1bc850a028a975f0cbc">NewLC()</a> </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00054">54</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8c4ec9ad89fd0b9168c50472fa3e1ec7"></a><!-- doxytag: member="CSharedIntermediator::AddBluetoothInfoL" ref="a8c4ec9ad89fd0b9168c50472fa3e1ec7" args="(TBluetoothInfo &aBtInfoElement)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSharedIntermediator::AddBluetoothInfoL </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_t_bluetooth_info.html">TBluetoothInfo</a> & </td>
<td class="paramname"> <em>aBtInfoElement</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#a8c4ec9ad89fd0b9168c50472fa3e1ec7">AddBluetoothInfoL()</a></p>
<p>discussion Add <a class="el" href="class_t_bluetooth_info.html">TBluetoothInfo</a> object into iBluetoothInfoArray which contains bluetooth device's data and adds new bluetooth device's name into UI's list box. param aNamEntry name of the device. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00075">75</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a22888d5681085c1321e3e3890bc0c780"></a><!-- doxytag: member="CSharedIntermediator::ResetArray" ref="a22888d5681085c1321e3e3890bc0c780" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSharedIntermediator::ResetArray </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#a1691ecc4482d77cd453f621163947d3c">DeviceListContainer()</a></p>
<p>discussion Clears bluetooth info array. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00095">95</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="accce976d88b563b511fee0754aac51d7"></a><!-- doxytag: member="CSharedIntermediator::GetAddress" ref="accce976d88b563b511fee0754aac51d7" args="(TDes &aAddress, TInt aIndex)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSharedIntermediator::GetAddress </td>
<td>(</td>
<td class="paramtype">TDes & </td>
<td class="paramname"> <em>aAddress</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aIndex</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#accce976d88b563b511fee0754aac51d7">GetAddress()</a></p>
<p>discussion Get bluetooth device address from iBluetoothInfoArray. param Address Returned a bluetooth device address. param aIndex valid index of iBluetoothInfoArray. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00132">132</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a90e24ea996df35031bcee2bd575abbcb"></a><!-- doxytag: member="CSharedIntermediator::SetStopSearching" ref="a90e24ea996df35031bcee2bd575abbcb" args="(bool aStopSearching)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSharedIntermediator::SetStopSearching </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>aStopSearching</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#a90e24ea996df35031bcee2bd575abbcb">SetStopSearching()</a></p>
<p>discussion Set class member variable, which tells to thread that Activescheduler's wait loop should stop. After that thread cleans up itself and is terminated "naturally". param aStopSearching new value for parameter iStopSearching. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00150">150</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a8d00c726b3de0ad952e32d0ed9a89364"></a><!-- doxytag: member="CSharedIntermediator::StopSearching" ref="a8d00c726b3de0ad952e32d0ed9a89364" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TBool CSharedIntermediator::StopSearching </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#a8d00c726b3de0ad952e32d0ed9a89364">StopSearching()</a></p>
<p>discussion Get class member variable, which tells to thread that Activescheduler's wait loop should stop. return True when program should be closed, false otherwise. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00160">160</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2914f06c89de0dc1c1477b5f3f0a73fb"></a><!-- doxytag: member="CSharedIntermediator::BTRefreshTimerPtr" ref="a2914f06c89de0dc1c1477b5f3f0a73fb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> * CSharedIntermediator::BTRefreshTimerPtr </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#a2914f06c89de0dc1c1477b5f3f0a73fb">BTRefreshTimerPtr()</a></p>
<p>discussion Get thread's bluetooth refresh timer pointer. New refresh time is set in main program. return thread one's bluetooth refresh timer pointer. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00172">172</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac22c0341f159855b73e858050d6114b1"></a><!-- doxytag: member="CSharedIntermediator::SetBTRefreshTimerPtr" ref="ac22c0341f159855b73e858050d6114b1" args="(CBluetoothRefreshTimer *aTimer)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSharedIntermediator::SetBTRefreshTimerPtr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_c_bluetooth_refresh_timer.html">CBluetoothRefreshTimer</a> * </td>
<td class="paramname"> <em>aTimer</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#ac22c0341f159855b73e858050d6114b1">SetBTRefreshTimerPtr()</a></p>
<p>discussion Set thread's bluetooth refresh timer pointer. New refresh time is set in main program. param aTimer is bluetooth discovery refresh timer. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00183">183</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1691ecc4482d77cd453f621163947d3c"></a><!-- doxytag: member="CSharedIntermediator::DeviceListContainer" ref="a1691ecc4482d77cd453f621163947d3c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_c_device_list_container.html">CDeviceListContainer</a> * CSharedIntermediator::DeviceListContainer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#a1691ecc4482d77cd453f621163947d3c">DeviceListContainer()</a></p>
<p>discussion Get UI's container pointer. Function is used when thread one CBTRefreshTimer clears UI's listbox. return thread one bluetooth refresh timer pointer. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00194">194</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9760bf8202ebb31c85f1a81fe48d2575"></a><!-- doxytag: member="CSharedIntermediator::SetRefreshTimerInitlVal" ref="a9760bf8202ebb31c85f1a81fe48d2575" args="(TInt aRefreshTime)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CSharedIntermediator::SetRefreshTimerInitlVal </td>
<td>(</td>
<td class="paramtype">TInt </td>
<td class="paramname"> <em>aRefreshTime</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#a9760bf8202ebb31c85f1a81fe48d2575">SetRefreshTimerInitlVal()</a></p>
<p>discussion Set CBTRefreshTimer's initial refresh time. param aRefreshTime is a new refresh time. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00107">107</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a028d5958e4503d319b594412bf118a3d"></a><!-- doxytag: member="CSharedIntermediator::RefreshTimerInitlVal" ref="a028d5958e4503d319b594412bf118a3d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TInt CSharedIntermediator::RefreshTimerInitlVal </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p><a class="el" href="class_c_shared_intermediator.html#a9760bf8202ebb31c85f1a81fe48d2575">SetRefreshTimerInitlVal()</a></p>
<p>discussion Get CBTRefreshTimer's initial refresh time. return CBTRefreshTimer instance's initial time. </p>
<p>Definition at line <a class="el" href="sharedintermediator_8cpp_source.html#l00122">122</a> of file <a class="el" href="sharedintermediator_8cpp_source.html">sharedintermediator.cpp</a>.</p>
</div>
</div>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>