summaryrefslogtreecommitdiff
path: root/freebsdtvision/doc/html/tobjstrm_8h.html
blob: a7f572918d3a367b4a240f640fff86c245e72270 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<!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>tobjstrm.h File 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> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>tobjstrm.h File Reference</h1>
<p>
<a href="tobjstrm_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
<tr><td nowrap align=right valign=top>struct &nbsp;</td><td valign=bottom><a class="el" href="structfLink.html">fLink</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Internal structure.</em> <a href="structfLink.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classfpbase.html">fpbase</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Base class for handling streamable objects on file streams.</em> <a href="classfpbase.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classfpstream.html">fpstream</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Provides the base class for simultaneous writing and reading streamable objects to bidirectional file streams.</em> <a href="classfpstream.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classifpstream.html">ifpstream</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Provides the base class for reading (extracting) streamable objects from file streams.</em> <a href="classifpstream.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classiopstream.html">iopstream</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The base class for simultaneous writing and reading streamable objects to and from streams.</em> <a href="classiopstream.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classipstream.html">ipstream</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The base class for reading (extracting) streamable objects from streams.</em> <a href="classipstream.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classofpstream.html">ofpstream</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Provides the base class for writing (inserting) streamable objects to file streams.</em> <a href="classofpstream.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classopstream.html">opstream</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The base class for writing (inserting) streamable objects into streams.</em> <a href="classopstream.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classTPReadObjects.html">TPReadObjects</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Maintains a database of all objects that have been read from the current object stream.</em> <a href="classTPReadObjects.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classpstream.html">pstream</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The base class for handling streamable objects.</em> <a href="classpstream.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classTPWObj.html">TPWObj</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Used internally by <a class="el" href="classTPWrittenObjects.html">TPWrittenObjects</a>.</em> <a href="classTPWObj.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classTPWrittenObjects.html">TPWrittenObjects</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Maintains a database of all objects that have been written to the current object stream.</em> <a href="classTPWrittenObjects.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classTStreamable.html">TStreamable</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Gives the streamable property to a class.</em> <a href="classTStreamable.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classTStreamableClass.html">TStreamableClass</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>TStreamableClass is used by <a class="el" href="classTStreamableTypes.html">TStreamableTypes</a> and pstream in the registration of streamable classes.</em> <a href="classTStreamableClass.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>class &nbsp;</td><td valign=bottom><a class="el" href="classTStreamableTypes.html">TStreamableTypes</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Maintains a database of all registered streamable types used in an application.</em> <a href="classTStreamableTypes.html#_details">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Typedefs</h2></td></tr>
<tr><td nowrap align=right valign=top>typedef unsigned&nbsp;</td><td valign=bottom><a class="el" href="tobjstrm_8h.html#a0">P_id_type</a></td></tr>
<tr><td nowrap align=right valign=top>typedef <a class="el" href="classTStreamable.html">TStreamable</a> *(*&nbsp;</td><td valign=bottom><a class="el" href="tobjstrm_8h.html#a2">BUILDER</a> )()</td></tr>
<tr><td colspan=2><br><h2>Variables</h2></td></tr>
<tr><td nowrap align=right valign=top>const <a class="el" href="tobjstrm_8h.html#a0">P_id_type</a>&nbsp;</td><td valign=bottom><a class="el" href="tobjstrm_8h.html#a1">P_id_notFound</a> = UINT_MAX</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
 <a class="el" href="tobjstrm_8h.html">tobjstrm.h</a>
<p>

<p>
Definition in file <a class="el" href="tobjstrm_8h-source.html">tobjstrm.h</a>.<hr><h2>Typedef Documentation</h2>
<a name="a2" doxytag="tobjstrm.h::BUILDER"></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"> typedef <a class="el" href="classTStreamable.html">TStreamable</a>*(* BUILDER)()
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Each streamable class has a builder function of type BUILDER. The builder provides raw memory of the correct size and initializes the virtual table pointers when objects are created by certain stream read operations. The read() function of the streamable class reads data from the stream into the raw object provided by the builder. <dl compact><dt><b>See also: </b></dt><dd>
<a class="el" href="classTStreamable.html#b0">TStreamable::read</a> </dl>
<p>
Definition at line <a class="el" href="tobjstrm_8h-source.html#l00145">145</a> of file <a class="el" href="tobjstrm_8h-source.html">tobjstrm.h</a>.    </td>
  </tr>
</table>
<a name="a0" doxytag="tobjstrm.h::P_id_type"></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"> typedef unsigned P_id_type
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Undocumented. 
<p>
Definition at line <a class="el" href="tobjstrm_8h-source.html#l00019">19</a> of file <a class="el" href="tobjstrm_8h-source.html">tobjstrm.h</a>.    </td>
  </tr>
</table>
<hr><h2>Variable Documentation</h2>
<a name="a1" doxytag="tobjstrm.h::P_id_notFound"></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"> const <a class="el" href="tobjstrm_8h.html#a0">P_id_type</a> P_id_notFound = UINT_MAX
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Undocumented. 
<p>
Definition at line <a class="el" href="tobjstrm_8h-source.html#l00135">135</a> of file <a class="el" href="tobjstrm_8h-source.html">tobjstrm.h</a>.    </td>
  </tr>
</table>
<hr><address style="align: right;"><small>Generated on Wed Apr 2 22:13:11 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>