[964] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
---|
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
---|
| 3 | <title>FCollada: FUStatus Class Reference</title> |
---|
| 4 | <link href="doxygen.css" rel="stylesheet" type="text/css"> |
---|
| 5 | <link href="tabs.css" rel="stylesheet" type="text/css"> |
---|
| 6 | </head><body> |
---|
| 7 | <!-- Generated by Doxygen 1.4.6-NO --> |
---|
| 8 | <div class="tabs"> |
---|
| 9 | <ul> |
---|
| 10 | <li><a href="index.html"><span>Main Page</span></a></li> |
---|
| 11 | <li><a href="modules.html"><span>Modules</span></a></li> |
---|
| 12 | <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
---|
| 13 | <li id="current"><a href="classes.html"><span>Classes</span></a></li> |
---|
| 14 | <li><a href="files.html"><span>Files</span></a></li> |
---|
| 15 | <li><a href="pages.html"><span>Related Pages</span></a></li> |
---|
| 16 | </ul></div> |
---|
| 17 | <div class="tabs"> |
---|
| 18 | <ul> |
---|
| 19 | <li><a href="classes.html"><span>Alphabetical List</span></a></li> |
---|
| 20 | <li><a href="annotated.html"><span>Class List</span></a></li> |
---|
| 21 | <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
---|
| 22 | <li><a href="functions.html"><span>Class Members</span></a></li> |
---|
| 23 | </ul></div> |
---|
| 24 | <h1>FUStatus Class Reference<br> |
---|
| 25 | <small> |
---|
| 26 | [<a class="el" href="group___f_utils.html">Utility Classes.</a>]</small> |
---|
| 27 | </h1><!-- doxytag: class="FUStatus" -->A return status structure that includes a string. |
---|
| 28 | <a href="#_details">More...</a> |
---|
| 29 | <p> |
---|
| 30 | <code>#include <<a class="el" href="_f_u_status_8h-source.html">FUStatus.h</a>></code> |
---|
| 31 | <p> |
---|
| 32 | <a href="class_f_u_status-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
---|
| 33 | <tr><td></td></tr> |
---|
| 34 | <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
---|
| 35 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#95cc52f06f3c36cd598dc6493ff411ed">FUStatus</a> (bool _callSuccessful=true)</td></tr> |
---|
| 36 | |
---|
| 37 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Default Constructor. <a href="#95cc52f06f3c36cd598dc6493ff411ed"></a><br></td></tr> |
---|
| 38 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#8ed1c51f2a3cb594483e22dae22c2b74">Fail</a> ()</td></tr> |
---|
| 39 | |
---|
| 40 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the value of the return code to 'failure'. <a href="#8ed1c51f2a3cb594483e22dae22c2b74"></a><br></td></tr> |
---|
| 41 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#225b2b3fdafef154091fa333244131ed">Fail</a> (const fstring &str, size_t line=0)</td></tr> |
---|
| 42 | |
---|
| 43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the value of the return code to 'failure'. <a href="#225b2b3fdafef154091fa333244131ed"></a><br></td></tr> |
---|
| 44 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d736196ab7f2f99f6b7272dbfa8d1cf6"></a><!-- doxytag: member="FUStatus::Fail" ref="d736196ab7f2f99f6b7272dbfa8d1cf6" args="(const fchar *str, size_t line=0)" --> |
---|
| 45 | <a class="el" href="class_f_u_status.html">FUStatus</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#d736196ab7f2f99f6b7272dbfa8d1cf6">Fail</a> (const fchar *str, size_t line=0)</td></tr> |
---|
| 46 | |
---|
| 47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 48 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#4e02200571518e858fc7479a8d356fee">Warning</a> (const fstring &str, size_t line=0)</td></tr> |
---|
| 49 | |
---|
| 50 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Adds a warning to the return status. <a href="#4e02200571518e858fc7479a8d356fee"></a><br></td></tr> |
---|
| 51 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="78c9361cf78240d07febaa74c799c4d7"></a><!-- doxytag: member="FUStatus::Warning" ref="78c9361cf78240d07febaa74c799c4d7" args="(const fchar *str, size_t line=0)" --> |
---|
| 52 | <a class="el" href="class_f_u_status.html">FUStatus</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#78c9361cf78240d07febaa74c799c4d7">Warning</a> (const fchar *str, size_t line=0)</td></tr> |
---|
| 53 | |
---|
| 54 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 55 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#ea95ead156fcd99b4517c175c7723215">AppendStatus</a> (const <a class="el" href="class_f_u_status.html">FUStatus</a> &a)</td></tr> |
---|
| 56 | |
---|
| 57 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Merges two return stati together. <a href="#ea95ead156fcd99b4517c175c7723215"></a><br></td></tr> |
---|
| 58 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#f9be553d66c4eed961aa0cfba003e343">AppendString</a> (const fstring &str)</td></tr> |
---|
| 59 | |
---|
| 60 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Appends a return string to the return status. <a href="#f9be553d66c4eed961aa0cfba003e343"></a><br></td></tr> |
---|
| 61 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="616204ac2234fa98dfb7c3efa42c31dc"></a><!-- doxytag: member="FUStatus::AppendString" ref="616204ac2234fa98dfb7c3efa42c31dc" args="(const fchar *str)" --> |
---|
| 62 | void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#616204ac2234fa98dfb7c3efa42c31dc">AppendString</a> (const fchar *str)</td></tr> |
---|
| 63 | |
---|
| 64 | <tr><td class="mdescLeft"> </td><td class="mdescRight">See above. <br></td></tr> |
---|
| 65 | <tr><td class="memItemLeft" nowrap align="right" valign="top">const fchar * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#7eb0eb84fdbd29571b6498847ad609bd">GetErrorString</a> () const </td></tr> |
---|
| 66 | |
---|
| 67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves the error/return string for this return status. <a href="#7eb0eb84fdbd29571b6498847ad609bd"></a><br></td></tr> |
---|
| 68 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#d42a14919d643345a864dc11c5d4c143">IsSuccessful</a> () const </td></tr> |
---|
| 69 | |
---|
| 70 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether the return status is 'successful'. <a href="#d42a14919d643345a864dc11c5d4c143"></a><br></td></tr> |
---|
| 71 | <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#fad1ae342a9c6c4bba87d1e7ed1eb9dd">IsFailure</a> () const </td></tr> |
---|
| 72 | |
---|
| 73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves whether the return status is 'failure'. <a href="#fad1ae342a9c6c4bba87d1e7ed1eb9dd"></a><br></td></tr> |
---|
| 74 | <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_u_status.html#485abc5dd5eb7dd81d1d35fbe1fe2591">operator bool</a> () const </td></tr> |
---|
| 75 | |
---|
| 76 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Transforms the return status into a boolean primitive. <a href="#485abc5dd5eb7dd81d1d35fbe1fe2591"></a><br></td></tr> |
---|
| 77 | </table> |
---|
| 78 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
| 79 | A return status structure that includes a string. |
---|
| 80 | <p> |
---|
| 81 | Contains a return code as well as a string which explains the errors and warnings attached to the return code. The return code is either 'successful' or 'failure'. If the return code is 'failure', proceeding normally may be dangerous. This structure is used by the <a class="el" href="class_f_c_document.html">FCDocument</a> classes to explain parsing errors. |
---|
| 82 | <p> |
---|
| 83 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
| 84 | <a class="anchor" name="95cc52f06f3c36cd598dc6493ff411ed"></a><!-- doxytag: member="FUStatus::FUStatus" ref="95cc52f06f3c36cd598dc6493ff411ed" args="(bool _callSuccessful=true)" --><p> |
---|
| 85 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 86 | <tr> |
---|
| 87 | <td class="mdRow"> |
---|
| 88 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 89 | <tr> |
---|
| 90 | <td class="md" nowrap valign="top">FUStatus::FUStatus </td> |
---|
| 91 | <td class="md" valign="top">( </td> |
---|
| 92 | <td class="md" nowrap valign="top">bool </td> |
---|
| 93 | <td class="mdname1" valign="top" nowrap> <em>_callSuccessful</em> = <code>true</code> </td> |
---|
| 94 | <td class="md" valign="top"> ) </td> |
---|
| 95 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 96 | </tr> |
---|
| 97 | </table> |
---|
| 98 | </td> |
---|
| 99 | </tr> |
---|
| 100 | </table> |
---|
| 101 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 102 | <tr> |
---|
| 103 | <td> |
---|
| 104 | |
---|
| 105 | </td> |
---|
| 106 | <td> |
---|
| 107 | |
---|
| 108 | <p> |
---|
| 109 | Default Constructor. |
---|
| 110 | <p> |
---|
| 111 | The default return code is 'successful'. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 112 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 113 | <tr><td valign="top"></td><td valign="top"><em>_callSuccessful</em> </td><td>Whether the return code should be set to 'successful'. </td></tr> |
---|
| 114 | </table> |
---|
| 115 | </dl> |
---|
| 116 | </td> |
---|
| 117 | </tr> |
---|
| 118 | </table> |
---|
| 119 | <hr><h2>Member Function Documentation</h2> |
---|
| 120 | <a class="anchor" name="ea95ead156fcd99b4517c175c7723215"></a><!-- doxytag: member="FUStatus::AppendStatus" ref="ea95ead156fcd99b4517c175c7723215" args="(const FUStatus &a)" --><p> |
---|
| 121 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 122 | <tr> |
---|
| 123 | <td class="mdRow"> |
---|
| 124 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 125 | <tr> |
---|
| 126 | <td class="md" nowrap valign="top">void FUStatus::AppendStatus </td> |
---|
| 127 | <td class="md" valign="top">( </td> |
---|
| 128 | <td class="md" nowrap valign="top">const <a class="el" href="class_f_u_status.html">FUStatus</a> & </td> |
---|
| 129 | <td class="mdname1" valign="top" nowrap> <em>a</em> </td> |
---|
| 130 | <td class="md" valign="top"> ) </td> |
---|
| 131 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 132 | </tr> |
---|
| 133 | </table> |
---|
| 134 | </td> |
---|
| 135 | </tr> |
---|
| 136 | </table> |
---|
| 137 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 138 | <tr> |
---|
| 139 | <td> |
---|
| 140 | |
---|
| 141 | </td> |
---|
| 142 | <td> |
---|
| 143 | |
---|
| 144 | <p> |
---|
| 145 | Merges two return stati together. |
---|
| 146 | <p> |
---|
| 147 | Appends to this return status the error string from the given status. The merged return code is 'failure', if either return codes are 'failure'. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 148 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 149 | <tr><td valign="top"></td><td valign="top"><em>a</em> </td><td>The return status to merge with. </td></tr> |
---|
| 150 | </table> |
---|
| 151 | </dl> |
---|
| 152 | </td> |
---|
| 153 | </tr> |
---|
| 154 | </table> |
---|
| 155 | <a class="anchor" name="f9be553d66c4eed961aa0cfba003e343"></a><!-- doxytag: member="FUStatus::AppendString" ref="f9be553d66c4eed961aa0cfba003e343" args="(const fstring &str)" --><p> |
---|
| 156 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 157 | <tr> |
---|
| 158 | <td class="mdRow"> |
---|
| 159 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 160 | <tr> |
---|
| 161 | <td class="md" nowrap valign="top">void FUStatus::AppendString </td> |
---|
| 162 | <td class="md" valign="top">( </td> |
---|
| 163 | <td class="md" nowrap valign="top">const fstring & </td> |
---|
| 164 | <td class="mdname1" valign="top" nowrap> <em>str</em> </td> |
---|
| 165 | <td class="md" valign="top"> ) </td> |
---|
| 166 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 167 | </tr> |
---|
| 168 | </table> |
---|
| 169 | </td> |
---|
| 170 | </tr> |
---|
| 171 | </table> |
---|
| 172 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 173 | <tr> |
---|
| 174 | <td> |
---|
| 175 | |
---|
| 176 | </td> |
---|
| 177 | <td> |
---|
| 178 | |
---|
| 179 | <p> |
---|
| 180 | Appends a return string to the return status. |
---|
| 181 | <p> |
---|
| 182 | A 'newline' code is added between return strings. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 183 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 184 | <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>The return string to append. </td></tr> |
---|
| 185 | </table> |
---|
| 186 | </dl> |
---|
| 187 | </td> |
---|
| 188 | </tr> |
---|
| 189 | </table> |
---|
| 190 | <a class="anchor" name="225b2b3fdafef154091fa333244131ed"></a><!-- doxytag: member="FUStatus::Fail" ref="225b2b3fdafef154091fa333244131ed" args="(const fstring &str, size_t line=0)" --><p> |
---|
| 191 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 192 | <tr> |
---|
| 193 | <td class="mdRow"> |
---|
| 194 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 195 | <tr> |
---|
| 196 | <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a>& FUStatus::Fail </td> |
---|
| 197 | <td class="md" valign="top">( </td> |
---|
| 198 | <td class="md" nowrap valign="top">const fstring & </td> |
---|
| 199 | <td class="mdname" nowrap> <em>str</em>, </td> |
---|
| 200 | </tr> |
---|
| 201 | <tr> |
---|
| 202 | <td class="md" nowrap align="right"></td> |
---|
| 203 | <td class="md"></td> |
---|
| 204 | <td class="md" nowrap>size_t </td> |
---|
| 205 | <td class="mdname" nowrap> <em>line</em> = <code>0</code></td> |
---|
| 206 | </tr> |
---|
| 207 | <tr> |
---|
| 208 | <td class="md"></td> |
---|
| 209 | <td class="md">) </td> |
---|
| 210 | <td class="md" colspan="2"><code> [inline]</code></td> |
---|
| 211 | </tr> |
---|
| 212 | </table> |
---|
| 213 | </td> |
---|
| 214 | </tr> |
---|
| 215 | </table> |
---|
| 216 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 217 | <tr> |
---|
| 218 | <td> |
---|
| 219 | |
---|
| 220 | </td> |
---|
| 221 | <td> |
---|
| 222 | |
---|
| 223 | <p> |
---|
| 224 | Sets the value of the return code to 'failure'. |
---|
| 225 | <p> |
---|
| 226 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 227 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 228 | <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>The error string for the error encountered. </td></tr> |
---|
| 229 | <tr><td valign="top"></td><td valign="top"><em>line</em> </td><td>A line number. </td></tr> |
---|
| 230 | </table> |
---|
| 231 | </dl> |
---|
| 232 | <dl compact><dt><b>Returns:</b></dt><dd>The return status structure. Returns itself to support multiple subsequent operations in one statement. </dd></dl> |
---|
| 233 | </td> |
---|
| 234 | </tr> |
---|
| 235 | </table> |
---|
| 236 | <a class="anchor" name="8ed1c51f2a3cb594483e22dae22c2b74"></a><!-- doxytag: member="FUStatus::Fail" ref="8ed1c51f2a3cb594483e22dae22c2b74" args="()" --><p> |
---|
| 237 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 238 | <tr> |
---|
| 239 | <td class="mdRow"> |
---|
| 240 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 241 | <tr> |
---|
| 242 | <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a>& FUStatus::Fail </td> |
---|
| 243 | <td class="md" valign="top">( </td> |
---|
| 244 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 245 | <td class="md" valign="top"> ) </td> |
---|
| 246 | <td class="md" nowrap><code> [inline]</code></td> |
---|
| 247 | </tr> |
---|
| 248 | </table> |
---|
| 249 | </td> |
---|
| 250 | </tr> |
---|
| 251 | </table> |
---|
| 252 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 253 | <tr> |
---|
| 254 | <td> |
---|
| 255 | |
---|
| 256 | </td> |
---|
| 257 | <td> |
---|
| 258 | |
---|
| 259 | <p> |
---|
| 260 | Sets the value of the return code to 'failure'. |
---|
| 261 | <p> |
---|
| 262 | <dl compact><dt><b>Returns:</b></dt><dd>The error code structure. Returns itself to support multiple subsequent operations in one statement. </dd></dl> |
---|
| 263 | </td> |
---|
| 264 | </tr> |
---|
| 265 | </table> |
---|
| 266 | <a class="anchor" name="7eb0eb84fdbd29571b6498847ad609bd"></a><!-- doxytag: member="FUStatus::GetErrorString" ref="7eb0eb84fdbd29571b6498847ad609bd" args="() const " --><p> |
---|
| 267 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 268 | <tr> |
---|
| 269 | <td class="mdRow"> |
---|
| 270 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 271 | <tr> |
---|
| 272 | <td class="md" nowrap valign="top">const fchar* FUStatus::GetErrorString </td> |
---|
| 273 | <td class="md" valign="top">( </td> |
---|
| 274 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 275 | <td class="md" valign="top"> ) </td> |
---|
| 276 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 277 | </tr> |
---|
| 278 | </table> |
---|
| 279 | </td> |
---|
| 280 | </tr> |
---|
| 281 | </table> |
---|
| 282 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 283 | <tr> |
---|
| 284 | <td> |
---|
| 285 | |
---|
| 286 | </td> |
---|
| 287 | <td> |
---|
| 288 | |
---|
| 289 | <p> |
---|
| 290 | Retrieves the error/return string for this return status. |
---|
| 291 | <p> |
---|
| 292 | <dl compact><dt><b>Returns:</b></dt><dd>The return string. </dd></dl> |
---|
| 293 | </td> |
---|
| 294 | </tr> |
---|
| 295 | </table> |
---|
| 296 | <a class="anchor" name="fad1ae342a9c6c4bba87d1e7ed1eb9dd"></a><!-- doxytag: member="FUStatus::IsFailure" ref="fad1ae342a9c6c4bba87d1e7ed1eb9dd" args="() const " --><p> |
---|
| 297 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 298 | <tr> |
---|
| 299 | <td class="mdRow"> |
---|
| 300 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 301 | <tr> |
---|
| 302 | <td class="md" nowrap valign="top">bool FUStatus::IsFailure </td> |
---|
| 303 | <td class="md" valign="top">( </td> |
---|
| 304 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 305 | <td class="md" valign="top"> ) </td> |
---|
| 306 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 307 | </tr> |
---|
| 308 | </table> |
---|
| 309 | </td> |
---|
| 310 | </tr> |
---|
| 311 | </table> |
---|
| 312 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 313 | <tr> |
---|
| 314 | <td> |
---|
| 315 | |
---|
| 316 | </td> |
---|
| 317 | <td> |
---|
| 318 | |
---|
| 319 | <p> |
---|
| 320 | Retrieves whether the return status is 'failure'. |
---|
| 321 | <p> |
---|
| 322 | <dl compact><dt><b>Returns:</b></dt><dd>Whether the return status is 'failure'. </dd></dl> |
---|
| 323 | </td> |
---|
| 324 | </tr> |
---|
| 325 | </table> |
---|
| 326 | <a class="anchor" name="d42a14919d643345a864dc11c5d4c143"></a><!-- doxytag: member="FUStatus::IsSuccessful" ref="d42a14919d643345a864dc11c5d4c143" args="() const " --><p> |
---|
| 327 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 328 | <tr> |
---|
| 329 | <td class="mdRow"> |
---|
| 330 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 331 | <tr> |
---|
| 332 | <td class="md" nowrap valign="top">bool FUStatus::IsSuccessful </td> |
---|
| 333 | <td class="md" valign="top">( </td> |
---|
| 334 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 335 | <td class="md" valign="top"> ) </td> |
---|
| 336 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 337 | </tr> |
---|
| 338 | </table> |
---|
| 339 | </td> |
---|
| 340 | </tr> |
---|
| 341 | </table> |
---|
| 342 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 343 | <tr> |
---|
| 344 | <td> |
---|
| 345 | |
---|
| 346 | </td> |
---|
| 347 | <td> |
---|
| 348 | |
---|
| 349 | <p> |
---|
| 350 | Retrieves whether the return status is 'successful'. |
---|
| 351 | <p> |
---|
| 352 | <dl compact><dt><b>Returns:</b></dt><dd>Whether the return status is 'successful'. </dd></dl> |
---|
| 353 | </td> |
---|
| 354 | </tr> |
---|
| 355 | </table> |
---|
| 356 | <a class="anchor" name="485abc5dd5eb7dd81d1d35fbe1fe2591"></a><!-- doxytag: member="FUStatus::operator bool" ref="485abc5dd5eb7dd81d1d35fbe1fe2591" args="() const " --><p> |
---|
| 357 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 358 | <tr> |
---|
| 359 | <td class="mdRow"> |
---|
| 360 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 361 | <tr> |
---|
| 362 | <td class="md" nowrap valign="top">FUStatus::operator bool </td> |
---|
| 363 | <td class="md" valign="top">( </td> |
---|
| 364 | <td class="mdname1" valign="top" nowrap> </td> |
---|
| 365 | <td class="md" valign="top"> ) </td> |
---|
| 366 | <td class="md" nowrap> const<code> [inline]</code></td> |
---|
| 367 | </tr> |
---|
| 368 | </table> |
---|
| 369 | </td> |
---|
| 370 | </tr> |
---|
| 371 | </table> |
---|
| 372 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 373 | <tr> |
---|
| 374 | <td> |
---|
| 375 | |
---|
| 376 | </td> |
---|
| 377 | <td> |
---|
| 378 | |
---|
| 379 | <p> |
---|
| 380 | Transforms the return status into a boolean primitive. |
---|
| 381 | <p> |
---|
| 382 | <dl compact><dt><b>Returns:</b></dt><dd>Whether the return status is 'successful'. </dd></dl> |
---|
| 383 | </td> |
---|
| 384 | </tr> |
---|
| 385 | </table> |
---|
| 386 | <a class="anchor" name="4e02200571518e858fc7479a8d356fee"></a><!-- doxytag: member="FUStatus::Warning" ref="4e02200571518e858fc7479a8d356fee" args="(const fstring &str, size_t line=0)" --><p> |
---|
| 387 | <table class="mdTable" cellpadding="2" cellspacing="0"> |
---|
| 388 | <tr> |
---|
| 389 | <td class="mdRow"> |
---|
| 390 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
| 391 | <tr> |
---|
| 392 | <td class="md" nowrap valign="top"><a class="el" href="class_f_u_status.html">FUStatus</a>& FUStatus::Warning </td> |
---|
| 393 | <td class="md" valign="top">( </td> |
---|
| 394 | <td class="md" nowrap valign="top">const fstring & </td> |
---|
| 395 | <td class="mdname" nowrap> <em>str</em>, </td> |
---|
| 396 | </tr> |
---|
| 397 | <tr> |
---|
| 398 | <td class="md" nowrap align="right"></td> |
---|
| 399 | <td class="md"></td> |
---|
| 400 | <td class="md" nowrap>size_t </td> |
---|
| 401 | <td class="mdname" nowrap> <em>line</em> = <code>0</code></td> |
---|
| 402 | </tr> |
---|
| 403 | <tr> |
---|
| 404 | <td class="md"></td> |
---|
| 405 | <td class="md">) </td> |
---|
| 406 | <td class="md" colspan="2"><code> [inline]</code></td> |
---|
| 407 | </tr> |
---|
| 408 | </table> |
---|
| 409 | </td> |
---|
| 410 | </tr> |
---|
| 411 | </table> |
---|
| 412 | <table cellspacing="5" cellpadding="0" border="0"> |
---|
| 413 | <tr> |
---|
| 414 | <td> |
---|
| 415 | |
---|
| 416 | </td> |
---|
| 417 | <td> |
---|
| 418 | |
---|
| 419 | <p> |
---|
| 420 | Adds a warning to the return status. |
---|
| 421 | <p> |
---|
| 422 | A warning does not set the return code to 'failure'. <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
| 423 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
| 424 | <tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>The warning string for the error encountered. </td></tr> |
---|
| 425 | <tr><td valign="top"></td><td valign="top"><em>line</em> </td><td>A line number. </td></tr> |
---|
| 426 | </table> |
---|
| 427 | </dl> |
---|
| 428 | <dl compact><dt><b>Returns:</b></dt><dd>The return status structure. Returns itself to support multiple subsequent operations in one statement. </dd></dl> |
---|
| 429 | </td> |
---|
| 430 | </tr> |
---|
| 431 | </table> |
---|
| 432 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
| 433 | <li>FUtils/<a class="el" href="_f_u_status_8h-source.html">FUStatus.h</a></ul> |
---|
| 434 | <hr size="1"><address style="align: right;"><small>Generated on Fri May 12 16:44:44 2006 for FCollada by |
---|
| 435 | <a href="http://www.doxygen.org/index.html"> |
---|
| 436 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6-NO </small></address> |
---|
| 437 | </body> |
---|
| 438 | </html> |
---|