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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
.TH "Engine" 3 "19 Jul 2003" "CommonC++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Engine \- Engine stream serialization of persistent classes.
.SH SYNOPSIS
.br
.PP
\fC#include <persist.h>\fP
.PP
.SS "Public Types"
.in +1c
.ti -1c
.RI "enum \fBEngineMode\fP { \fBmodeRead\fP, \fBmodeWrite\fP }"
.br
.RI "\fIThese are the modes the Persistence::Engine can work in.\fP"
.in -1c
.SS "Public Methods"
.in +1c
.ti -1c
.RI "\fBCCXX_MEMBER_EXPORT\fP (CCXX_EMPTY) Engine(std"
.br
.RI "\fIwrites a \fBBaseObject\fP from a reference.\fP"
.ti -1c
.RI "\fBCCXX_MEMBER_EXPORT\fP (void) write(const \fBBaseObject\fP *object) THROWS(\fBException\fP)"
.br
.RI "\fIwrites a \fBBaseObject\fP from a pointer.\fP"
.ti -1c
.RI "void \fBwrite\fP (\fBint8\fP i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBuint8\fP i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBint16\fP i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBuint16\fP i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBint32\fP i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBuint32\fP i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBint64\fP i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBwrite\fP (\fBuint64\fP i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBwrite\fP (float i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBwrite\fP (double i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "\fBCCXX_MEMBER_EXPORT\fP (void) write(const std"
.br
.RI "\fIreads a \fBBaseObject\fP into a pointer allocating memory for the object if necessary.\fP"
.ti -1c
.RI "void \fBread\fP (\fBuint8\fP &i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBread\fP (\fBint16\fP &i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBread\fP (\fBuint16\fP &i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBread\fP (\fBint32\fP &i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBread\fP (\fBuint32\fP &i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBread\fP (\fBint64\fP &i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBread\fP (\fBuint64\fP &i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBread\fP (float &i) THROWS(\fBException\fP)"
.br
.ti -1c
.RI "void \fBread\fP (double &i) THROWS(\fBException\fP)"
.br
.in -1c
.SS "Related Functions"
(Note that these are not member functions.)
.in +1c
.ti -1c
.RI "\fBCCXX_EXPORT\fP(Engine &) operator>>(Engine &ar"
.br
.ti -1c
.RI "template<class T> Engine & \fBoperator<<\fP (Engine &ar, typename std::vector< T > const &ob) THROWS(Engine"
.br
.RI "\fIserialize a vector of some serializable content to the engine\fP"
.ti -1c
.RI "template<class T> Engine & \fBoperator>>\fP (Engine &ar, typename std::vector< T > &ob) THROWS(Engine"
.br
.RI "\fIdeserialize a vector of deserializable content from an engine.\fP"
.ti -1c
.RI "template<class T> Engine & \fBoperator<<\fP (Engine &ar, typename std::deque< T > const &ob) THROWS(Engine"
.br
.RI "\fIserialize a deque of some serializable content to the engine\fP"
.ti -1c
.RI "template<class T> Engine & \fBoperator>>\fP (Engine &ar, typename std::deque< T > &ob) THROWS(Engine"
.br
.RI "\fIdeserialize a deque of deserializable content from an engine.\fP"
.ti -1c
.RI "template<class Key, class Value> Engine & \fBoperator<<\fP (Engine &ar, typename std::map< Key, Value > const &ob) THROWS(Engine"
.br
.RI "\fIserialize a map with keys/values which both are serializeable to an engine.\fP"
.ti -1c
.RI "template<class Key, class Value> Engine & \fBoperator>>\fP (Engine &ar, typename std::map< Key, Value > &ob) THROWS(Engine"
.br
.RI "\fIdeserialize a map with keys/values which both are serializeable from an engine.\fP"
.in -1c
.SH "DETAILED DESCRIPTION"
.PP
Engine stream serialization of persistent classes.
.PP
This class constructs on a standard C++ STL stream and then operates in the mode specified. The stream passed into the constructor must be a binary mode to function properly.
.PP
\fBAuthor: \fP
.in +1c
Daniel Silverstone
.PP
.SH "MEMBER ENUMERATION DOCUMENTATION"
.PP
.SS "enum Engine::EngineMode"
.PP
These are the modes the Persistence::Engine can work in.
.PP
\fBEnumeration values: \fP
.in +1c
.TP
\fB\fI\fImodeRead\fP \fP\fP
.TP
\fB\fI\fImodeWrite\fP \fP\fP
.SH "MEMBER FUNCTION DOCUMENTATION"
.PP
.SS "Engine::CCXX_MEMBER_EXPORT (void) const\fC [inline]\fP"
.PP
reads a \fBBaseObject\fP into a pointer allocating memory for the object if necessary.
.PP
.SS "Engine::CCXX_MEMBER_EXPORT (void) const"
.PP
writes a \fBBaseObject\fP from a pointer.
.PP
.SS "Engine::CCXX_MEMBER_EXPORT (CCXX_EMPTY)\fC [inline]\fP"
.PP
writes a \fBBaseObject\fP from a reference.
.PP
.SS "void Engine::read (double & i)\fC [inline]\fP"
.PP
.SS "void Engine::read (float & i)\fC [inline]\fP"
.PP
.SS "void Engine::read (\fBuint64\fP & i)\fC [inline]\fP"
.PP
.SS "void Engine::read (\fBint64\fP & i)\fC [inline]\fP"
.PP
.SS "void Engine::read (\fBuint32\fP & i)\fC [inline]\fP"
.PP
.SS "void Engine::read (\fBint32\fP & i)\fC [inline]\fP"
.PP
.SS "void Engine::read (\fBuint16\fP & i)\fC [inline]\fP"
.PP
.SS "void Engine::read (\fBint16\fP & i)\fC [inline]\fP"
.PP
.SS "void Engine::read (\fBuint8\fP & i)\fC [inline]\fP"
.PP
.SS "void Engine::write (double i)\fC [inline]\fP"
.PP
.SS "void Engine::write (float i)\fC [inline]\fP"
.PP
.SS "void Engine::write (\fBuint64\fP i)\fC [inline]\fP"
.PP
.SS "void Engine::write (\fBint64\fP i)\fC [inline]\fP"
.PP
.SS "void Engine::write (\fBuint32\fP i)\fC [inline]\fP"
.PP
.SS "void Engine::write (\fBint32\fP i)\fC [inline]\fP"
.PP
.SS "void Engine::write (\fBuint16\fP i)\fC [inline]\fP"
.PP
.SS "void Engine::write (\fBint16\fP i)\fC [inline]\fP"
.PP
.SS "void Engine::write (\fBuint8\fP i)\fC [inline]\fP"
.PP
.SS "void Engine::write (\fBint8\fP i)\fC [inline]\fP"
.PP
.SH "FRIENDS AND RELATED FUNCTION DOCUMENTATION"
.PP
.SS "CCXX_EXPORT(Engine &)\fC [related]\fP"
.PP
.SS "template<class Key, class Value> Engine & operator<< (Engine & ar, typename std::map< Key, Value > const & ob)\fC [related]\fP"
.PP
serialize a map with keys/values which both are serializeable to an engine.
.PP
.SS "template<class T> Engine & operator<< (Engine & ar, typename std::deque< T > const & ob)\fC [related]\fP"
.PP
serialize a deque of some serializable content to the engine
.PP
.SS "template<class T> Engine & operator<< (Engine & ar, typename std::vector< T > const & ob)\fC [related]\fP"
.PP
serialize a vector of some serializable content to the engine
.PP
.SS "template<class Key, class Value> Engine & operator>> (Engine & ar, typename std::map< Key, Value > & ob)\fC [related]\fP"
.PP
deserialize a map with keys/values which both are serializeable from an engine.
.PP
.SS "template<class T> Engine & operator>> (Engine & ar, typename std::deque< T > & ob)\fC [related]\fP"
.PP
deserialize a deque of deserializable content from an engine.
.PP
.SS "template<class T> Engine & operator>> (Engine & ar, typename std::vector< T > & ob)\fC [related]\fP"
.PP
deserialize a vector of deserializable content from an engine.
.PP
.SH "AUTHOR"
.PP
Generated automatically by Doxygen for CommonC++ from the source code.
|
