<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>MPQC: MPQC::ComponentFactory_impl 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.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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"><b>MPQC</b>::<a class="el" href="classMPQC_1_1ComponentFactory__impl.html">ComponentFactory_impl</a>
</div>
</div>
<div class="contents">
<h1>MPQC::ComponentFactory_impl Class Reference</h1><!-- doxytag: class="MPQC::ComponentFactory_impl" -->Symbol "MPQC.ComponentFactory" (version 0.2).
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="MPQC__ComponentFactory__Impl_8hh_source.html">MPQC_ComponentFactory_Impl.hh</a>></code>
<p>
<p>
<a href="classMPQC_1_1ComponentFactory__impl-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"><a class="anchor" name="5c75434dcacd8e6a75541c213badda6c"></a><!-- doxytag: member="MPQC::ComponentFactory_impl::ComponentFactory_impl" ref="5c75434dcacd8e6a75541c213badda6c" args="(struct MPQC_ComponentFactory__object *s)" -->
</td><td class="memItemRight" valign="bottom"><b>ComponentFactory_impl</b> (struct MPQC_ComponentFactory__object *s)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2c62e14108a5d17c48a82c1b2f8b102d"></a><!-- doxytag: member="MPQC::ComponentFactory_impl::_ctor" ref="2c62e14108a5d17c48a82c1b2f8b102d" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>_ctor</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="be961f49a8d702412c0a57574f048dcc"></a><!-- doxytag: member="MPQC::ComponentFactory_impl::_dtor" ref="be961f49a8d702412c0a57574f048dcc" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>_dtor</b> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c4dbae665e4338862b9f0e2510a53812"></a><!-- doxytag: member="MPQC::ComponentFactory_impl::addDescription" ref="c4dbae665e4338862b9f0e2510a53812" args="(const ::std::string &className, const ::std::string &classAlias)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPQC_1_1ComponentFactory__impl.html#c4dbae665e4338862b9f0e2510a53812">addDescription</a> (const ::std::string &className, const ::std::string &classAlias) throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">user defined non-static method. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">::sidl::array<br class="typebreak">
< ::gov::cca::ComponentClassDescription > </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPQC_1_1ComponentFactory__impl.html#0985472a09fce52e9f65d59035bd576e">getAvailableComponentClasses</a> () throw ( ::gov::cca::CCAException )</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Collect the currently obtainable class name strings from factories known to the builder and the from the already instantiated components. <a href="#0985472a09fce52e9f65d59035bd576e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">::gov::cca::Component </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPQC_1_1ComponentFactory__impl.html#1961e14b927e706f7b77c432f67521bc">createComponentInstance</a> (const ::std::string &className) throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">the component instance returned is nil if the name is unknown to the factory. <a href="#1961e14b927e706f7b77c432f67521bc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMPQC_1_1ComponentFactory__impl.html#ae443cf9c421f0128861da2517a9fa02">destroyComponentInstance</a> (const ::std::string &className,::gov::cca::Component c) throw ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">reclaim any resources the factory may have associated with the port it is using. <a href="#ae443cf9c421f0128861da2517a9fa02"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="324a54b3235922a53211d9932b2655c1"></a><!-- doxytag: member="MPQC::ComponentFactory_impl::_load" ref="324a54b3235922a53211d9932b2655c1" args="()" -->
static void </td><td class="memItemRight" valign="bottom"><b>_load</b> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Symbol "MPQC.ComponentFactory" (version 0.2).
<p>
ComponentFactory implements a CCA standard component interface for component factories. This class is used to inform the embedded framework of available components in a statically linked executable.<p>
This is an implementation of a SIDL interface. The stub code is generated by the Babel tool. Do not make modifications outside of splicer blocks, as these will be lost. This is a server implementation for a Babel class, the Babel client code is provided by the cca-spec-babel package. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="1961e14b927e706f7b77c432f67521bc"></a><!-- doxytag: member="MPQC::ComponentFactory_impl::createComponentInstance" ref="1961e14b927e706f7b77c432f67521bc" args="(const ::std::string &className)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">::gov::cca::Component MPQC::ComponentFactory_impl::createComponentInstance </td>
<td>(</td>
<td class="paramtype">const ::std::string & </td>
<td class="paramname"> <em>className</em> </td>
<td> ) </td>
<td> throw ()</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
the component instance returned is nil if the name is unknown to the factory.
<p>
The component is raw: it has been constructed but not initialized via setServices.
</div>
</div><p>
<a class="anchor" name="ae443cf9c421f0128861da2517a9fa02"></a><!-- doxytag: member="MPQC::ComponentFactory_impl::destroyComponentInstance" ref="ae443cf9c421f0128861da2517a9fa02" args="(const ::std::string &className,::gov::cca::Component c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MPQC::ComponentFactory_impl::destroyComponentInstance </td>
<td>(</td>
<td class="paramtype">const ::std::string & </td>
<td class="paramname"> <em>className</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">::gov::cca::Component </td>
<td class="paramname"> <em>c</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> throw ()</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
reclaim any resources the factory may have associated with the port it is using.
<p>
This will occur after the normal component shutdown (ala componentrelease) is finished.
</div>
</div><p>
<a class="anchor" name="0985472a09fce52e9f65d59035bd576e"></a><!-- doxytag: member="MPQC::ComponentFactory_impl::getAvailableComponentClasses" ref="0985472a09fce52e9f65d59035bd576e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">::sidl::array< ::gov::cca::ComponentClassDescription> MPQC::ComponentFactory_impl::getAvailableComponentClasses </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> throw ( ::gov::cca::CCAException )</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Collect the currently obtainable class name strings from factories known to the builder and the from the already instantiated components.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The list of class description, which may be empty, that are known a priori to contain valid values for the className argument of createInstance. </dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>CCAException</em> </td><td>in the event of error. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="MPQC__ComponentFactory__Impl_8hh_source.html">MPQC_ComponentFactory_Impl.hh</a></ul>
</div>
<hr>
<address>
<small>
Generated at Wed Oct 14 14:12:12 2009 for <a
href="http://www.mpqc.org">MPQC</a>
2.3.1 using the documentation package <a
href="http://www.doxygen.org">Doxygen</a>
1.5.9.
</small>
</address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
247b28499c443e092731ffba814075f2
>
files
>
85
