diff options
Diffstat (limited to 'freebsdtvision/doc/html/classfpstream.html')
| -rw-r--r-- | freebsdtvision/doc/html/classfpstream.html | 299 |
1 files changed, 299 insertions, 0 deletions
diff --git a/freebsdtvision/doc/html/classfpstream.html b/freebsdtvision/doc/html/classfpstream.html new file mode 100644 index 0000000..b5832f5 --- /dev/null +++ b/freebsdtvision/doc/html/classfpstream.html @@ -0,0 +1,299 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>fpstream class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.2.18 --> +<center> +<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> +<hr><h1>fpstream Class Reference</h1>Provides the base class for simultaneous writing and reading streamable objects to bidirectional file streams. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="tobjstrm_8h-source.html">tobjstrm.h</a>></code> +<p> +<p>Inheritance diagram for fpstream: +<p><center><img src="classfpstream.png" usemap="#fpstream_map" border="0" alt=""></center> +<map name="fpstream_map"> +<area href="classfpbase.html" alt="fpbase" shape="rect" coords="0,112,66,136"> +<area href="classiopstream.html" alt="iopstream" shape="rect" coords="114,112,180,136"> +<area href="classpstream.html" alt="pstream" shape="rect" coords="0,56,66,80"> +<area href="classipstream.html" alt="ipstream" shape="rect" coords="76,56,142,80"> +<area href="classopstream.html" alt="opstream" shape="rect" coords="152,56,218,80"> +<area href="classpstream.html" alt="pstream" shape="rect" coords="76,0,142,24"> +<area href="classpstream.html" alt="pstream" shape="rect" coords="152,0,218,24"> +</map> +<a href="classfpstream-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 Methods</h2></td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classfpstream.html#a0">fpstream</a> ()</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classfpstream.html#a1">fpstream</a> (const char *name, int omode, int prot=filebuf::openprot)</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classfpstream.html#a2">fpstream</a> (int f)</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classfpstream.html#a3">fpstream</a> (int f, char *b, int len)</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classfpstream.html#a4">~fpstream</a> ()</td></tr> +<tr><td nowrap align=right valign=top>filebuf * </td><td valign=bottom><a class="el" href="classfpstream.html#a5">rdbuf</a> ()</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classfpstream.html#a6">open</a> (const char *name, int omode, int prot=filebuf::openprot)</td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +fpstream is a simple "mix" of its bases, fpbase and iopstream. It provides the base class for simultaneous writing and reading streamable objects to bidirectional file streams. It is analogous to class fstream, defined in `fstream.h' for the standard C++ stream library. +<p> + +<p> +Definition at line <a class="el" href="tobjstrm_8h-source.html#l01170">1170</a> of file <a class="el" href="tobjstrm_8h-source.html">tobjstrm.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> +<a name="a0" doxytag="fpstream::fpstream"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> fpstream::fpstream </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a buffered fpstream object. </td> + </tr> +</table> +<a name="a1" doxytag="fpstream::fpstream"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> fpstream::fpstream </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname" nowrap> <em>name</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>omode</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>prot</em> = filebuf::openprot</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a buffered fpstream object. You can open a file and attach it to the stream by specifying the `name', `omode', and `prot' (protection) arguments. </td> + </tr> +</table> +<a name="a2" doxytag="fpstream::fpstream"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> fpstream::fpstream </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname1" valign="top" nowrap> <em>f</em> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a buffered fpstream object. You can open a file and attach it to the stream by specifying the file descriptor, `f'. </td> + </tr> +</table> +<a name="a3" doxytag="fpstream::fpstream"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> fpstream::fpstream </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">int </td> + <td class="mdname" nowrap> <em>f</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>char * </td> + <td class="mdname" nowrap> <em>b</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>len</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Creates a buffered fpstream object. You can set the size and initial contents of the buffer using the `len' and `b' arguments. You can open a file and attach it to the stream by specifying the file descriptor, `f'. </td> + </tr> +</table> +<a name="a4" doxytag="fpstream::~fpstream"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> fpstream::~fpstream </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Destroys the fpstream object. </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a name="a6" doxytag="fpstream::open"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void fpstream::open </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const char * </td> + <td class="mdname" nowrap> <em>name</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>omode</em>, </td> + </tr> + <tr> + <td></td> + <td></td> + <td class="md" nowrap>int </td> + <td class="mdname" nowrap> <em>prot</em> = filebuf::openprot</td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Opens the named file in the given mode (app, ate, in, out, binary, trunc, nocreate, noreplace) and protection. The opened file is attatched to this stream. +<p> +Reimplemented from <a class="el" href="classfpbase.html#a5">fpbase</a>. </td> + </tr> +</table> +<a name="a5" doxytag="fpstream::rdbuf"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> filebuf* fpstream::rdbuf </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top">) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Returns the data member bp. +<p> +Reimplemented from <a class="el" href="classfpbase.html#a9">fpbase</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following file:<ul> +<li><a class="el" href="tobjstrm_8h-source.html">tobjstrm.h</a></ul> +<hr><address style="align: right;"><small>Generated on Wed Apr 2 22:13:13 2003 for TVision by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 +width=110 height=53></a>1.2.18 </small></address> +</body> +</html> |