<!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::StateInText 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_1StateInText.html">StateInText</a> </div> </div> <div class="contents"> <h1>sc::StateInText Class Reference</h1><!-- doxytag: class="sc::StateInText" --><!-- doxytag: inherits="sc::StateInFile" -->Reads state information written with <a class="el" href="classsc_1_1StateOutText.html" title="Writes out state information in an almost human readable format.">StateOutText</a>. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="state__text_8h_source.html">state_text.h</a>></code> <p> <div class="dynheader"> Inheritance diagram for sc::StateInText:</div> <div class="dynsection"> <p><center><img src="classsc_1_1StateInText.png" usemap="#sc::StateInText_map" border="0" alt=""></center> <map name="sc::StateInText_map"> <area href="classsc_1_1StateInFile.html" alt="sc::StateInFile" shape="rect" coords="0,224,120,248"> <area href="classsc_1_1StateIn.html" alt="sc::StateIn" shape="rect" coords="0,168,120,192"> <area href="classsc_1_1DescribedClass.html" alt="sc::DescribedClass" shape="rect" coords="0,112,120,136"> <area href="classsc_1_1RefCount.html" alt="sc::RefCount" shape="rect" coords="0,56,120,80"> <area href="classsc_1_1Identity.html" alt="sc::Identity" shape="rect" coords="0,0,120,24"> </map> </div> <p> <a href="classsc_1_1StateInText-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="32dac9a447b6c5141b4226b580db36af"></a><!-- doxytag: member="sc::StateInText::StateInText" ref="32dac9a447b6c5141b4226b580db36af" args="(std::istream &s)" --> </td><td class="memItemRight" valign="bottom"><b>StateInText</b> (std::istream &s)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e57646df7ce29298d129f6197a003067"></a><!-- doxytag: member="sc::StateInText::StateInText" ref="e57646df7ce29298d129f6197a003067" args="(const char *)" --> </td><td class="memItemRight" valign="bottom"><b>StateInText</b> (const char *)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="38072c9cb09037ab72e3a497db537423"></a><!-- doxytag: member="sc::StateInText::StateInText" ref="38072c9cb09037ab72e3a497db537423" args="(const Ref< KeyVal > &)" --> </td><td class="memItemRight" valign="bottom"><b>StateInText</b> (const <a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1KeyVal.html">KeyVal</a> > &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b8028fbb29c60fd2e59f0551ee90f34c"></a><!-- doxytag: member="sc::StateInText::getstring" ref="b8028fbb29c60fd2e59f0551ee90f34c" args="(char *&)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StateInText.html#b8028fbb29c60fd2e59f0551ee90f34c">getstring</a> (char *&)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">This restores strings saved with <a class="el" href="classsc_1_1StateOut.html#5d6a62cef6fd5d76a9c1e7c12db4aeb2" title="This is like put except the length of the char array is determined by interpreting...">StateOut::putstring</a>. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StateInText.html#60bbad1e191ffeb3c754ae52f1a4c342">get_array_char</a> (char *, int)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">These restore data saved with StateOut's put. <a href="#60bbad1e191ffeb3c754ae52f1a4c342"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3a5875bde06182517aef5a33a749968f"></a><!-- doxytag: member="sc::StateInText::get_array_uint" ref="3a5875bde06182517aef5a33a749968f" args="(unsigned int *, int)" --> int </td><td class="memItemRight" valign="bottom"><b>get_array_uint</b> (unsigned int *, int)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ae4532f595e2befd97240b4f977e6732"></a><!-- doxytag: member="sc::StateInText::get_array_int" ref="ae4532f595e2befd97240b4f977e6732" args="(int *, int)" --> int </td><td class="memItemRight" valign="bottom"><b>get_array_int</b> (int *, int)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7def88496f310d957b4812dee433522d"></a><!-- doxytag: member="sc::StateInText::get_array_float" ref="7def88496f310d957b4812dee433522d" args="(float *, int)" --> int </td><td class="memItemRight" valign="bottom"><b>get_array_float</b> (float *, int)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67806fc58d7bc529c782b2ff0d278efb"></a><!-- doxytag: member="sc::StateInText::get_array_double" ref="67806fc58d7bc529c782b2ff0d278efb" args="(double *, int)" --> int </td><td class="memItemRight" valign="bottom"><b>get_array_double</b> (double *, int)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StateInText.html#e99f2dff3b103255cb0ebd3f16809883">get</a> (const <a class="el" href="classsc_1_1ClassDesc.html">ClassDesc</a> **)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">This restores ClassDesc's. <a href="#e99f2dff3b103255cb0ebd3f16809883"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d86d8573b7a20e781ccc28009e4041ba"></a><!-- doxytag: member="sc::StateInText::get" ref="d86d8573b7a20e781ccc28009e4041ba" args="(char &r, const char *key=0)" --> int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StateInText.html#d86d8573b7a20e781ccc28009e4041ba">get</a> (char &r, const char *key=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">These restore data saved with StateOut's put. members. <br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8c0cf1025e0b1a966789b10ac013d5a"></a><!-- doxytag: member="sc::StateInText::get" ref="c8c0cf1025e0b1a966789b10ac013d5a" args="(unsigned int &r, const char *key=0)" --> int </td><td class="memItemRight" valign="bottom"><b>get</b> (unsigned int &r, const char *key=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="0a2440377a2809f36359c524ab0c5d89"></a><!-- doxytag: member="sc::StateInText::get" ref="0a2440377a2809f36359c524ab0c5d89" args="(int &r, const char *key=0)" --> int </td><td class="memItemRight" valign="bottom"><b>get</b> (int &r, const char *key=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c64105d5c5b32d3404cf02dfb9986948"></a><!-- doxytag: member="sc::StateInText::get" ref="c64105d5c5b32d3404cf02dfb9986948" args="(float &r, const char *key=0)" --> int </td><td class="memItemRight" valign="bottom"><b>get</b> (float &r, const char *key=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="45aa1c9852cd90f30d3e7a65c8bbaa59"></a><!-- doxytag: member="sc::StateInText::get" ref="45aa1c9852cd90f30d3e7a65c8bbaa59" args="(double &r, const char *key=0)" --> int </td><td class="memItemRight" valign="bottom"><b>get</b> (double &r, const char *key=0)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StateInText.html#e4847afb98b6ab2c0eaaa39161ad80e6">get</a> (char *&)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">These restore data saved with StateOut's put. <a href="#e4847afb98b6ab2c0eaaa39161ad80e6"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b002c32463d41356496b207e5c4d8116"></a><!-- doxytag: member="sc::StateInText::get" ref="b002c32463d41356496b207e5c4d8116" args="(unsigned int *&)" --> int </td><td class="memItemRight" valign="bottom"><b>get</b> (unsigned int *&)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b48d927db6a26960faf53cfc7f37cbd"></a><!-- doxytag: member="sc::StateInText::get" ref="2b48d927db6a26960faf53cfc7f37cbd" args="(int *&)" --> int </td><td class="memItemRight" valign="bottom"><b>get</b> (int *&)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e30e6d839b44b291755d61aad0cdeff5"></a><!-- doxytag: member="sc::StateInText::get" ref="e30e6d839b44b291755d61aad0cdeff5" args="(float *&)" --> int </td><td class="memItemRight" valign="bottom"><b>get</b> (float *&)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="686b2deee04a6ee1a1350a09560878bd"></a><!-- doxytag: member="sc::StateInText::get" ref="686b2deee04a6ee1a1350a09560878bd" args="(double *&)" --> int </td><td class="memItemRight" valign="bottom"><b>get</b> (double *&)</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="0f5cabf0fa30abfa357523bdfc133721"></a><!-- doxytag: member="sc::StateInText::no_newline" ref="0f5cabf0fa30abfa357523bdfc133721" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>no_newline</b> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="dbf7fd1451cfb2902da45f1ea2b38305"></a><!-- doxytag: member="sc::StateInText::no_array" ref="dbf7fd1451cfb2902da45f1ea2b38305" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>no_array</b> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7b99cc43248ca2ba8cd84650ca424015"></a><!-- doxytag: member="sc::StateInText::read" ref="7b99cc43248ca2ba8cd84650ca424015" args="(char *)" --> int </td><td class="memItemRight" valign="bottom"><b>read</b> (char *)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="726f2a8ecf6e95e9820cab8bebaa2efe"></a><!-- doxytag: member="sc::StateInText::read" ref="726f2a8ecf6e95e9820cab8bebaa2efe" args="(unsigned int &)" --> int </td><td class="memItemRight" valign="bottom"><b>read</b> (unsigned int &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f85f43dc95ceb035571745ebc97e0652"></a><!-- doxytag: member="sc::StateInText::read" ref="f85f43dc95ceb035571745ebc97e0652" args="(int &)" --> int </td><td class="memItemRight" valign="bottom"><b>read</b> (int &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="388756eca289f8a58fa6d57f26975fa3"></a><!-- doxytag: member="sc::StateInText::read" ref="388756eca289f8a58fa6d57f26975fa3" args="(float &)" --> int </td><td class="memItemRight" valign="bottom"><b>read</b> (float &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="20ef4e139081b0917f77f75d71102ca1"></a><!-- doxytag: member="sc::StateInText::read" ref="20ef4e139081b0917f77f75d71102ca1" args="(double &)" --> int </td><td class="memItemRight" valign="bottom"><b>read</b> (double &)</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="73274ff0005e60529fe62096fe61312c"></a><!-- doxytag: member="sc::StateInText::newline" ref="73274ff0005e60529fe62096fe61312c" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>newline</b> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e99bda990121bffe21c8ee2153a40fc2"></a><!-- doxytag: member="sc::StateInText::start_array" ref="e99bda990121bffe21c8ee2153a40fc2" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>start_array</b> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9a900369a04376b6e250073be6890d4b"></a><!-- doxytag: member="sc::StateInText::end_array" ref="9a900369a04376b6e250073be6890d4b" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>end_array</b> ()</td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classsc_1_1StateInText.html#e4c9490551063fc0f9bf243c90523cef">getobject</a> (<a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1SavableState.html">SavableState</a> > &)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">This is used to restore an object. <a href="#e4c9490551063fc0f9bf243c90523cef"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="68f2508737482897b2af1fdcd537ca07"></a><!-- doxytag: member="sc::StateInText::abort" ref="68f2508737482897b2af1fdcd537ca07" args="()" --> void </td><td class="memItemRight" valign="bottom"><b>abort</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="1b551cf83b04dc0a4b449becc51d0126"></a><!-- doxytag: member="sc::StateInText::newlines_" ref="1b551cf83b04dc0a4b449becc51d0126" args="" --> int </td><td class="memItemRight" valign="bottom"><b>newlines_</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ac85c15611cb1ee25b42022923e7d15b"></a><!-- doxytag: member="sc::StateInText::no_newline_" ref="ac85c15611cb1ee25b42022923e7d15b" args="" --> int </td><td class="memItemRight" valign="bottom"><b>no_newline_</b></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="5b1026c483ecfb5b1b070ff2be362f28"></a><!-- doxytag: member="sc::StateInText::no_array_" ref="5b1026c483ecfb5b1b070ff2be362f28" args="" --> int </td><td class="memItemRight" valign="bottom"><b>no_array_</b></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Reads state information written with <a class="el" href="classsc_1_1StateOutText.html" title="Writes out state information in an almost human readable format.">StateOutText</a>. <hr><h2>Member Function Documentation</h2> <a class="anchor" name="e4847afb98b6ab2c0eaaa39161ad80e6"></a><!-- doxytag: member="sc::StateInText::get" ref="e4847afb98b6ab2c0eaaa39161ad80e6" args="(char *&)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int sc::StateInText::get </td> <td>(</td> <td class="paramtype">char *& </td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> These restore data saved with StateOut's put. <p> members. The data is allocated by <a class="el" href="classsc_1_1StateIn.html" title="Restores objects that derive from SavableState.">StateIn</a>. <p>Reimplemented from <a class="el" href="classsc_1_1StateIn.html#29e5781aa2b6a0679d25725e83576775">sc::StateIn</a>.</p> </div> </div><p> <a class="anchor" name="e99f2dff3b103255cb0ebd3f16809883"></a><!-- doxytag: member="sc::StateInText::get" ref="e99f2dff3b103255cb0ebd3f16809883" args="(const ClassDesc **)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int sc::StateInText::get </td> <td>(</td> <td class="paramtype">const <a class="el" href="classsc_1_1ClassDesc.html">ClassDesc</a> ** </td> <td class="paramname"> </td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> This restores ClassDesc's. <p> It will set the pointer to the address of the static <a class="el" href="classsc_1_1ClassDesc.html" title="This class is used to contain information about classes.">ClassDesc</a> for the class which has the same name as the class that had the <a class="el" href="classsc_1_1ClassDesc.html" title="This class is used to contain information about classes.">ClassDesc</a> that was saved by put(const ClassDesc*). <p>Reimplemented from <a class="el" href="classsc_1_1StateIn.html#536c380ed76f68c36f45bf947ed2c750">sc::StateIn</a>.</p> </div> </div><p> <a class="anchor" name="60bbad1e191ffeb3c754ae52f1a4c342"></a><!-- doxytag: member="sc::StateInText::get_array_char" ref="60bbad1e191ffeb3c754ae52f1a4c342" args="(char *, int)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int sc::StateInText::get_array_char </td> <td>(</td> <td class="paramtype">char * </td> <td class="paramname"> <em>p</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">int </td> <td class="paramname"> <em>size</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> These restore data saved with StateOut's put. <p> members. The data must be preallocated by the user. <p>Reimplemented from <a class="el" href="classsc_1_1StateIn.html#e1c22e20bb93bcef31ae054a00c4cf70">sc::StateIn</a>.</p> </div> </div><p> <a class="anchor" name="e4c9490551063fc0f9bf243c90523cef"></a><!-- doxytag: member="sc::StateInText::getobject" ref="e4c9490551063fc0f9bf243c90523cef" args="(Ref< SavableState > &)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int sc::StateInText::getobject </td> <td>(</td> <td class="paramtype"><a class="el" href="classsc_1_1Ref.html">Ref</a>< <a class="el" href="classsc_1_1SavableState.html">SavableState</a> > & </td> <td class="paramname"> </td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p> This is used to restore an object. <p> It is called with the reference to the reference being restored. If the data being restored has previously been restored, then the pointer being restored is set to a reference to the previously restored object. <p>Reimplemented from <a class="el" href="classsc_1_1StateIn.html#5de6fac53e041f1445cc54d3b62934da">sc::StateIn</a>.</p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="state__text_8h_source.html">state_text.h</a></ul> </div> <hr> <address> <small> Generated at Wed Oct 14 14:12:17 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>