<!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>GNU CommonC++: ost::ttystream 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.3 --> <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> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</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="namespaceost.html">ost</a>::<a class="el" href="classost_1_1ttystream.html">ttystream</a> </div> </div> <div class="contents"> <h1>ost::ttystream Class Reference</h1><!-- doxytag: class="ost::ttystream" --><!-- doxytag: inherits="ost::TTYStream" --> <p>A more natural C++ "ttystream" class for use by non-threaded applications. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="serial_8h_source.html">serial.h</a>></code></p> <div class="dynheader"> Inheritance diagram for ost::ttystream:</div> <div class="dynsection"> <div class="center"> <img src="classost_1_1ttystream.png" usemap="#ost::ttystream_map" alt=""/> <map id="ost::ttystream_map" name="ost::ttystream_map"> <area href="classost_1_1_t_t_y_stream.html" alt="ost::TTYStream" shape="rect" coords="0,56,96,80"/> <area href="classost_1_1_serial.html" alt="ost::Serial" shape="rect" coords="0,0,96,24"/> </map> </div> </div> <p><a href="classost_1_1ttystream-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="classost_1_1ttystream.html#aecaa072538b632583b66b2efe0623d81">ttystream</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct an unopened "ttystream" object. <a href="#aecaa072538b632583b66b2efe0623d81"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1ttystream.html#a238f4a4287af882ea12c852d2f816931">ttystream</a> (const char *name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct and "open" a tty stream object. <a href="#a238f4a4287af882ea12c852d2f816931"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1ttystream.html#a9cd5bb27aace9c143b78af37330179e8">open</a> (const char *name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Open method for a tty stream. <a href="#a9cd5bb27aace9c143b78af37330179e8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1ttystream.html#a4c27b39599ec7550606bd6e3cdcbb6d7">close</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Close method for a tty stream. <a href="#a4c27b39599ec7550606bd6e3cdcbb6d7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1ttystream.html#a8e77838120b5128c2dfa48d0f9ccaebc">operator!</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Test to see if stream is opened. <a href="#a8e77838120b5128c2dfa48d0f9ccaebc"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A more natural C++ "ttystream" class for use by non-threaded applications. </p> <p>This class behaves a lot more like fstream and similar classes.</p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> C++ "fstream" style ttystream class. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="aecaa072538b632583b66b2efe0623d81"></a><!-- doxytag: member="ost::ttystream::ttystream" ref="aecaa072538b632583b66b2efe0623d81" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::ttystream::ttystream </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct an unopened "ttystream" object. </p> </div> </div> <a class="anchor" id="a238f4a4287af882ea12c852d2f816931"></a><!-- doxytag: member="ost::ttystream::ttystream" ref="a238f4a4287af882ea12c852d2f816931" args="(const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::ttystream::ttystream </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Construct and "open" a tty stream object. </p> <p>A filename in the form "device:options[,options]" may be used to pass device options as part of the open.</p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of file and serial options. </td></tr> </table> </dd> </dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a4c27b39599ec7550606bd6e3cdcbb6d7"></a><!-- doxytag: member="ost::ttystream::close" ref="a4c27b39599ec7550606bd6e3cdcbb6d7" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::ttystream::close </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Close method for a tty stream. </p> <p>Reimplemented from <a class="el" href="classost_1_1_serial.html#ab58a9efec4fffc41b7f0618734a549e0">ost::Serial</a>.</p> </div> </div> <a class="anchor" id="a9cd5bb27aace9c143b78af37330179e8"></a><!-- doxytag: member="ost::ttystream::open" ref="a9cd5bb27aace9c143b78af37330179e8" args="(const char *name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::ttystream::open </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Open method for a tty stream. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>filename to open. </td></tr> </table> </dd> </dl> <p>Reimplemented from <a class="el" href="classost_1_1_serial.html#aab0033a3ce6c142a4882f05187ff2749">ost::Serial</a>.</p> </div> </div> <a class="anchor" id="a8e77838120b5128c2dfa48d0f9ccaebc"></a><!-- doxytag: member="ost::ttystream::operator!" ref="a8e77838120b5128c2dfa48d0f9ccaebc" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::ttystream::operator! </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Test to see if stream is opened. </p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="serial_8h_source.html">serial.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Mar 12 10:07:41 2010 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>