<!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: sc::ClassDesc 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>sc</b>::<a class="el" href="classsc_1_1ClassDesc.html">ClassDesc</a> </div> </div> <div class="contents"> <h1>sc::ClassDesc Class Reference</h1><!-- doxytag: class="sc::ClassDesc" --><!-- doxytag: inherits="sc::Identity" -->This class is used to contain information about classes. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="class_8h_source.html">class.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for sc::ClassDesc:</div> <div class="dynsection"> <p><center><img src="classsc_1_1ClassDesc.png" usemap="#sc::ClassDesc_map" border="0" alt=""></center> <map name="sc::ClassDesc_map"> <area href="classsc_1_1Identity.html" alt="sc::Identity" shape="rect" coords="0,0,91,24"> </map> </div> <p> <a href="classsc_1_1ClassDesc-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="5a947646825c62fc080c04776c5c02e8"></a><!-- doxytag: member="sc::ClassDesc::ClassDesc" ref="5a947646825c62fc080c04776c5c02e8" args="(const std::type_info &, const char *, int=1, const char *p=0, DescribedClass *(*ctor)()=0, DescribedClass *(*keyvalctor)(const Ref< KeyVal > &)=0, DescribedClass *(*stateinctor)(StateIn &)=0)" --> </td><td class="memItemRight" valign="bottom"><b>ClassDesc</b> (const std::type_info &, const char *, int=1, const char *p=0, <a class="el" href="classsc_1_1DescribedClass.html">DescribedClass</a> *(*ctor)()=0, <a class="el" href="classsc_1_1DescribedClass.html">DescribedClass</a> *(*keyvalctor)(const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> > &)=0, <a class="el" href="classsc_1_1DescribedClass.html">DescribedClass</a> *(*stateinctor)(<a class="el" href="classsc_1_1StateIn.html">StateIn</a> &)=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="209c08c2d51851967d5d854612cdadab"></a><!-- doxytag: member="sc::ClassDesc::parents" ref="209c08c2d51851967d5d854612cdadab" args="() const " --> const <a class="el" href="classsc_1_1ParentClasses.html">ParentClasses</a> & </td><td class="memItemRight" valign="bottom"><b>parents</b> () const </td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="edb67a508a4cd82fead4ff10651ee1b8"></a><!-- doxytag: member="sc::ClassDesc::name" ref="edb67a508a4cd82fead4ff10651ee1b8" args="() const " --> const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1ClassDesc.html#edb67a508a4cd82fead4ff10651ee1b8">name</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the class. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ba9518960cb1ff115a1660b63d5e72ac"></a><!-- doxytag: member="sc::ClassDesc::version" ref="ba9518960cb1ff115a1660b63d5e72ac" args="() const " --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1ClassDesc.html#ba9518960cb1ff115a1660b63d5e72ac">version</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the version number of the class. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="10968217f7494235df5ea2ee363798a5"></a><!-- doxytag: member="sc::ClassDesc::create_described_class" ref="10968217f7494235df5ea2ee363798a5" args="() const " --> <a class="el" href="classsc_1_1DescribedClass.html">DescribedClass</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1ClassDesc.html#10968217f7494235df5ea2ee363798a5">create_described_class</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">This member has been replaced by <a class="el" href="classsc_1_1ClassDesc.html#a8e1c3ca9c99ba328d91005e902a25d5" title="Create an instance of DescribedClass with exact type equal to the class to which...">create()</a>. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classsc_1_1DescribedClass.html">DescribedClass</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1ClassDesc.html#a8e1c3ca9c99ba328d91005e902a25d5">create</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of <a class="el" href="classsc_1_1DescribedClass.html" title="Classes which need runtime information about themselves and their relationship to...">DescribedClass</a> with exact type equal to the class to which this class descriptor belongs. <a href="#a8e1c3ca9c99ba328d91005e902a25d5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classsc_1_1DescribedClass.html">DescribedClass</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1ClassDesc.html#10c61cb11ebdd165956c89364818b147">create</a> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> > &) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of <a class="el" href="classsc_1_1DescribedClass.html" title="Classes which need runtime information about themselves and their relationship to...">DescribedClass</a> with exact type equal to the class to which this class descriptor belongs. <a href="#10c61cb11ebdd165956c89364818b147"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classsc_1_1DescribedClass.html">DescribedClass</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1ClassDesc.html#aa150a62abba17ce7d7b32ede79fb07a">create</a> (<a class="el" href="classsc_1_1StateIn.html">StateIn</a> &) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create an instance of <a class="el" href="classsc_1_1DescribedClass.html" title="Classes which need runtime information about themselves and their relationship to...">DescribedClass</a> with exact type equal to the class to which this class descriptor belongs. <a href="#aa150a62abba17ce7d7b32ede79fb07a"></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="ce61fdb4189223fba195a65ca266947c"></a><!-- doxytag: member="sc::ClassDesc::all" ref="ce61fdb4189223fba195a65ca266947c" args="()" --> static std::map< std::string, <br class="typebreak"> <a class="el" href="classsc_1_1ClassDesc.html">ClassDescP</a> > & </td><td class="memItemRight" valign="bottom"><b>all</b> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="acbc5cd6e23d391fe249f75ec1417f4b"></a><!-- doxytag: member="sc::ClassDesc::list_all_classes" ref="acbc5cd6e23d391fe249f75ec1417f4b" args="()" --> static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1ClassDesc.html#acbc5cd6e23d391fe249f75ec1417f4b">list_all_classes</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a list of all of the classes to <a class="el" href="classsc_1_1ExEnv.html#360216acd1f990e999c0ed46cb350b1f" title="Return an ostream that writes from node 0.">ExEnv::out0()</a>. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsc_1_1ClassDesc.html">ClassDesc</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1ClassDesc.html#a5e74efb179390f71205cd91c42b2c83">name_to_class_desc</a> (const char *)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Given the name of the class, return a pointer to the class descriptor. <a href="#a5e74efb179390f71205cd91c42b2c83"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classsc_1_1ClassDesc.html">ClassDesc</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1ClassDesc.html#444e53a2c1199439108464994e73590d">class_desc</a> (const std::type_info &)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Given a type_info object return a pointer to the <a class="el" href="classsc_1_1ClassDesc.html" title="This class is used to contain information about classes.">ClassDesc</a>. <a href="#444e53a2c1199439108464994e73590d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1ClassDesc.html#27ba4aa6d6c1745021528e0f1a9430a6">load_class</a> (const char *classname)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Attempt to dynamically load the shared object file for classname. <a href="#27ba4aa6d6c1745021528e0f1a9430a6"></a><br></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="fdefcc0997f67fe4a3f35dfe9d4408ed"></a><!-- doxytag: member="sc::ClassDesc::ParentClasses" ref="fdefcc0997f67fe4a3f35dfe9d4408ed" args="" --> class </td><td class="memItemRight" valign="bottom"><b>ParentClasses</b></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> This class is used to contain information about classes. <p> Each <a class="el" href="classsc_1_1DescribedClass.html" title="Classes which need runtime information about themselves and their relationship to...">DescribedClass</a> type has a static <a class="el" href="classsc_1_1ClassDesc.html" title="This class is used to contain information about classes.">ClassDesc</a> member. This member has lists of the parents, children and virtual parents for each class. The <a class="el" href="classsc_1_1ClassDesc.html" title="This class is used to contain information about classes.">ClassDesc</a> class also has a static member that is a list of all described classes in the system. These lists are constructed as the constructors for the static <a class="el" href="classsc_1_1ClassDesc.html" title="This class is used to contain information about classes.">ClassDesc</a> members for each class are called and are completed before main is entered. See <a class="el" href="class.html">The Described Class Library</a> for more information. <hr><h2>Member Function Documentation</h2> <a class="anchor" name="444e53a2c1199439108464994e73590d"></a><!-- doxytag: member="sc::ClassDesc::class_desc" ref="444e53a2c1199439108464994e73590d" args="(const std::type_info &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classsc_1_1ClassDesc.html">ClassDesc</a>* sc::ClassDesc::class_desc </td> <td>(</td> <td class="paramtype">const std::type_info & </td> <td class="paramname"> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Given a type_info object return a pointer to the <a class="el" href="classsc_1_1ClassDesc.html" title="This class is used to contain information about classes.">ClassDesc</a>. <p> </div> </div><p> <a class="anchor" name="aa150a62abba17ce7d7b32ede79fb07a"></a><!-- doxytag: member="sc::ClassDesc::create" ref="aa150a62abba17ce7d7b32ede79fb07a" args="(StateIn &) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classsc_1_1DescribedClass.html">DescribedClass</a>* sc::ClassDesc::create </td> <td>(</td> <td class="paramtype"><a class="el" href="classsc_1_1StateIn.html">StateIn</a> & </td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create an instance of <a class="el" href="classsc_1_1DescribedClass.html" title="Classes which need runtime information about themselves and their relationship to...">DescribedClass</a> with exact type equal to the class to which this class descriptor belongs. <p> The <a class="el" href="classsc_1_1StateIn.html" title="Restores objects that derive from SavableState.">StateIn</a>& constructor is used. If this constructor doesn't exist or a static function that calls it with new wasn't passed to this <a class="el" href="classsc_1_1ClassDesc.html" title="This class is used to contain information about classes.">ClassDesc</a>, then 0 will be returned. </div> </div><p> <a class="anchor" name="10c61cb11ebdd165956c89364818b147"></a><!-- doxytag: member="sc::ClassDesc::create" ref="10c61cb11ebdd165956c89364818b147" args="(const Ref< KeyVal > &) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classsc_1_1DescribedClass.html">DescribedClass</a>* sc::ClassDesc::create </td> <td>(</td> <td class="paramtype">const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> > & </td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create an instance of <a class="el" href="classsc_1_1DescribedClass.html" title="Classes which need runtime information about themselves and their relationship to...">DescribedClass</a> with exact type equal to the class to which this class descriptor belongs. <p> The <a class="el" href="classsc_1_1KeyVal.html" title="The KeyVal class is designed to simplify the process of allowing a user to specify...">KeyVal</a>& constructor is used. If this constructor doesn't exist or a static function that calls it with new wasn't passed to this <a class="el" href="classsc_1_1ClassDesc.html" title="This class is used to contain information about classes.">ClassDesc</a>, then 0 will be returned. </div> </div><p> <a class="anchor" name="a8e1c3ca9c99ba328d91005e902a25d5"></a><!-- doxytag: member="sc::ClassDesc::create" ref="a8e1c3ca9c99ba328d91005e902a25d5" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual <a class="el" href="classsc_1_1DescribedClass.html">DescribedClass</a>* sc::ClassDesc::create </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td> const<code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Create an instance of <a class="el" href="classsc_1_1DescribedClass.html" title="Classes which need runtime information about themselves and their relationship to...">DescribedClass</a> with exact type equal to the class to which this class descriptor belongs. <p> The constructor which takes no arguments is used. If this constructor doesn't exist or a static function that calls it with new wasn't given to this <a class="el" href="classsc_1_1ClassDesc.html" title="This class is used to contain information about classes.">ClassDesc</a> when it was created, then 0 will be returned. </div> </div><p> <a class="anchor" name="27ba4aa6d6c1745021528e0f1a9430a6"></a><!-- doxytag: member="sc::ClassDesc::load_class" ref="27ba4aa6d6c1745021528e0f1a9430a6" args="(const char *classname)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static int sc::ClassDesc::load_class </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>classname</em> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Attempt to dynamically load the shared object file for classname. <p> </div> </div><p> <a class="anchor" name="a5e74efb179390f71205cd91c42b2c83"></a><!-- doxytag: member="sc::ClassDesc::name_to_class_desc" ref="a5e74efb179390f71205cd91c42b2c83" args="(const char *)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classsc_1_1ClassDesc.html">ClassDesc</a>* sc::ClassDesc::name_to_class_desc </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> </td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Given the name of the class, return a pointer to the class descriptor. <p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="class_8h_source.html">class.h</a></ul> </div> <hr> <address> <small> Generated at Wed Oct 14 14:12:16 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>