Updated documentation
[libs.git] / docs / html / class_sylph_1_1_serialization_exception.html
blob1694678847a0bd3939a98b71c53445edadbc1bed
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 <title>LibSylph: Sylph::SerializationException Class Reference</title>
4 <link href="doxygen.css" rel="stylesheet" type="text/css">
5 </head><body>
6 <!-- Generated by Doxygen 1.5.8 -->
7 <div class="navigation" id="top">
8 <div class="tabs">
9 <ul>
10 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12 <li class="current"><a href="classes.html"><span>Classes</span></a></li>
13 <li><a href="files.html"><span>Files</span></a></li>
14 <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
15 </ul>
16 </div>
17 <div class="tabs">
18 <ul>
19 <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
20 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
21 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
22 </ul>
23 </div>
24 <div class="navpath"><a class="el" href="namespace_sylph.html">Sylph</a>::<a class="el" href="class_sylph_1_1_serialization_exception.html">SerializationException</a>
25 </div>
26 </div>
27 <div class="contents">
28 <h1>Sylph::SerializationException Class Reference</h1><!-- doxytag: class="Sylph::SerializationException" --><!-- doxytag: inherits="Sylph::Exception" -->This <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a> gets thrown if there is a problem with serializing or deserializing an object.
29 <a href="#_details">More...</a>
30 <p>
31 <code>#include &lt;<a class="el" href="_exception_8h-source.html">Sylph/Core/Exception.h</a>&gt;</code>
32 <p>
33 <div class="dynheader">
34 Inheritance diagram for Sylph::SerializationException:</div>
35 <div class="dynsection">
36 <p><center><img src="class_sylph_1_1_serialization_exception__inherit__graph.png" border="0" usemap="#_sylph_1_1_serialization_exception__inherit__map" alt="Inheritance graph"></center>
37 <map name="_sylph_1_1_serialization_exception__inherit__map">
38 <area shape="rect" id="node2" href="class_sylph_1_1_exception.html" title="This class provides a ready&#45;to&#45;use interface for exception handling." alt="" coords="47,5,180,35"></map>
39 <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
41 <p>
42 <a href="class_sylph_1_1_serialization_exception-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
43 <tr><td></td></tr>
44 <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
45 <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_serialization_exception.html#644a24bfe9e0d21c368155324d9ae33f">name</a> () const throw ()</td></tr>
47 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the class name of this <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a>. <a href="#644a24bfe9e0d21c368155324d9ae33f"></a><br></td></tr>
48 <tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_exception.html#3b56cc13b4004aa72e7ea86f034f968c">what</a> () const throw ()</td></tr>
50 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the reason why this <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a> was thrown, i.e. the second parameter to <code>sthrow()</code>. <a href="#3b56cc13b4004aa72e7ea86f034f968c"></a><br></td></tr>
51 <tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sylph_1_1_exception.html#1038e3fb0e96d4733beb0ea03c4aad04">addTraceMessage</a> (const char *message) const throw ()</td></tr>
53 <tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function adds a message to the trace information inside this <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a>. <a href="#1038e3fb0e96d4733beb0ea03c4aad04"></a><br></td></tr>
54 </table>
55 <hr><a name="_details"></a><h2>Detailed Description</h2>
56 This <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a> gets thrown if there is a problem with serializing or deserializing an object. <hr><h2>Member Function Documentation</h2>
57 <a class="anchor" name="1038e3fb0e96d4733beb0ea03c4aad04"></a><!-- doxytag: member="Sylph::SerializationException::addTraceMessage" ref="1038e3fb0e96d4733beb0ea03c4aad04" args="(const char *message) const " -->
58 <div class="memitem">
59 <div class="memproto">
60 <table class="memname">
61 <tr>
62 <td class="memname">void Sylph::Exception::addTraceMessage </td>
63 <td>(</td>
64 <td class="paramtype">const char *&nbsp;</td>
65 <td class="paramname"> <em>message</em> </td>
66 <td>&nbsp;)&nbsp;</td>
67 <td> const throw ()<code> [inline, inherited]</code></td>
68 </tr>
69 </table>
70 </div>
71 <div class="memdoc">
73 <p>
74 This function adds a message to the trace information inside this <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a>.
75 <p>
76 It can be useful to add the name of a function the <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a> passes through (i.e. what <code>strace</code> does), or any other information you like to add to the <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a>. This information is purely diagnostic. <dl compact><dt><b>Parameters:</b></dt><dd>
77 <table border="0" cellspacing="2" cellpadding="0">
78 <tr><td valign="top"></td><td valign="top"><em>message</em>&nbsp;</td><td>The message to add in the traceinfo log. </td></tr>
79 </table>
80 </dl>
82 </div>
83 </div><p>
84 <a class="anchor" name="644a24bfe9e0d21c368155324d9ae33f"></a><!-- doxytag: member="Sylph::SerializationException::name" ref="644a24bfe9e0d21c368155324d9ae33f" args="() const " -->
85 <div class="memitem">
86 <div class="memproto">
87 <table class="memname">
88 <tr>
89 <td class="memname">virtual const char* Sylph::SerializationException::name </td>
90 <td>(</td>
91 <td class="paramname"> </td>
92 <td>&nbsp;)&nbsp;</td>
93 <td> const throw ()<code> [inline, virtual]</code></td>
94 </tr>
95 </table>
96 </div>
97 <div class="memdoc">
99 <p>
100 Returns the class name of this <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a>.
102 If you used the <code> S_CREATE_EXCEPTION(</code><em>name</em><code>)</code> macro, this will be automatically filled in for you. Otherwise you'll have to put in the name yourself. This is purely diagnostic information. <dl class="return" compact><dt><b>Returns:</b></dt><dd>The name of the class of this <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a>. </dd></dl>
104 <p>Reimplemented from <a class="el" href="class_sylph_1_1_exception.html#16528d47441cf5ffb45bcdbd119d1661">Sylph::Exception</a>.</p>
106 </div>
107 </div><p>
108 <a class="anchor" name="3b56cc13b4004aa72e7ea86f034f968c"></a><!-- doxytag: member="Sylph::SerializationException::what" ref="3b56cc13b4004aa72e7ea86f034f968c" args="() const " -->
109 <div class="memitem">
110 <div class="memproto">
111 <table class="memname">
112 <tr>
113 <td class="memname">const char* Sylph::Exception::what </td>
114 <td>(</td>
115 <td class="paramname"> </td>
116 <td>&nbsp;)&nbsp;</td>
117 <td> const throw ()<code> [inline, inherited]</code></td>
118 </tr>
119 </table>
120 </div>
121 <div class="memdoc">
124 Returns the reason why this <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a> was thrown, i.e. the second parameter to <code>sthrow()</code>.
126 <dl class="return" compact><dt><b>Returns:</b></dt><dd>The reason why this <a class="el" href="class_sylph_1_1_exception.html" title="This class provides a ready-to-use interface for exception handling.">Exception</a> was thrown. </dd></dl>
128 </div>
129 </div><p>
130 </div>
131 <hr size="1" class="unhidden"><address style="text-align: right;"><small>
132 Documentation for LibSylph by Doxygen
133 </body>
134 </html>