202 lines
12 KiB
HTML
202 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Shaka Packager SDK: shaka::Status Class Reference</title>
|
|
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="../../jquery.js"></script>
|
|
<script type="text/javascript" src="../../dynsections.js"></script>
|
|
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="../../search/searchdata.js"></script>
|
|
<script type="text/javascript" src="../../search/search.js"></script>
|
|
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Shaka Packager SDK
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="../../menudata.js"></script>
|
|
<script type="text/javascript" src="../../menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('../../',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="../../d8/daf/namespaceshaka.html">shaka</a></li><li class="navelem"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="../../d6/d5b/classshaka_1_1Status-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">shaka::Status Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a12c04257e2480e0ce87cd16b944921d0"><td class="memItemLeft" align="right" valign="top"><a id="a12c04257e2480e0ce87cd16b944921d0"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d20/classshaka_1_1Status.html#a12c04257e2480e0ce87cd16b944921d0">Status</a> ()</td></tr>
|
|
<tr class="memdesc:a12c04257e2480e0ce87cd16b944921d0"><td class="mdescLeft"> </td><td class="mdescRight">Creates a "successful" status. <br /></td></tr>
|
|
<tr class="separator:a12c04257e2480e0ce87cd16b944921d0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2fa2116c9e12215a4e3430b362ba622b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d20/classshaka_1_1Status.html#a2fa2116c9e12215a4e3430b362ba622b">Status</a> (error::Code error_code, const std::string &error_message)</td></tr>
|
|
<tr class="separator:a2fa2116c9e12215a4e3430b362ba622b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9c0536749c9abc21c1111e622de6b7c8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d20/classshaka_1_1Status.html#a9c0536749c9abc21c1111e622de6b7c8">Update</a> (<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> new_status)</td></tr>
|
|
<tr class="separator:a9c0536749c9abc21c1111e622de6b7c8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a07968bd8fefb47d2a5cde75b1e831c17"><td class="memItemLeft" align="right" valign="top"><a id="a07968bd8fefb47d2a5cde75b1e831c17"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>ok</b> () const</td></tr>
|
|
<tr class="separator:a07968bd8fefb47d2a5cde75b1e831c17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0dc23d64d67ecab45e0c73602d5f3b5b"><td class="memItemLeft" align="right" valign="top"><a id="a0dc23d64d67ecab45e0c73602d5f3b5b"></a>
|
|
error::Code </td><td class="memItemRight" valign="bottom"><b>error_code</b> () const</td></tr>
|
|
<tr class="separator:a0dc23d64d67ecab45e0c73602d5f3b5b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5679eacfd7929f0e1af0f2d25c49b5be"><td class="memItemLeft" align="right" valign="top"><a id="a5679eacfd7929f0e1af0f2d25c49b5be"></a>
|
|
const std::string & </td><td class="memItemRight" valign="bottom"><b>error_message</b> () const</td></tr>
|
|
<tr class="separator:a5679eacfd7929f0e1af0f2d25c49b5be"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab68e5e4cfbb0ebc54eb7fcffe9ffa34f"><td class="memItemLeft" align="right" valign="top"><a id="ab68e5e4cfbb0ebc54eb7fcffe9ffa34f"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> &x) const</td></tr>
|
|
<tr class="separator:ab68e5e4cfbb0ebc54eb7fcffe9ffa34f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a2504eaa44e9e6e278060e4ea6910a8a6"><td class="memItemLeft" align="right" valign="top"><a id="a2504eaa44e9e6e278060e4ea6910a8a6"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> &x) const</td></tr>
|
|
<tr class="separator:a2504eaa44e9e6e278060e4ea6910a8a6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6c5c3c528296f2cb0dec56506cb8d3c3"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d20/classshaka_1_1Status.html#a6c5c3c528296f2cb0dec56506cb8d3c3">ToString</a> () const</td></tr>
|
|
<tr class="separator:a6c5c3c528296f2cb0dec56506cb8d3c3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
|
Static Public Attributes</h2></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Some pre-defined Status objects.</div></td></tr>
|
|
<tr class="memitem:ac1d0f21a89f2db1989372e63ec172ad3"><td class="memItemLeft" align="right" valign="top"><a id="ac1d0f21a89f2db1989372e63ec172ad3"></a>
|
|
static const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>OK</b> = <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>(error::OK, "")</td></tr>
|
|
<tr class="separator:ac1d0f21a89f2db1989372e63ec172ad3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad05bbde77c2a2bb3ca1ee26184fda8c5"><td class="memItemLeft" align="right" valign="top"><a id="ad05bbde77c2a2bb3ca1ee26184fda8c5"></a>
|
|
static const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> </td><td class="memItemRight" valign="bottom"><b>UNKNOWN</b> = <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>(error::UNKNOWN, "")</td></tr>
|
|
<tr class="separator:ad05bbde77c2a2bb3ca1ee26184fda8c5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p class="definition">Definition at line <a class="el" href="../../d1/d13/status_8h_source.html#l00110">110</a> of file <a class="el" href="../../d1/d13/status_8h_source.html">status.h</a>.</p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a2fa2116c9e12215a4e3430b362ba622b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a2fa2116c9e12215a4e3430b362ba622b">◆ </a></span>Status()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">shaka::Status::Status </td>
|
|
<td>(</td>
|
|
<td class="paramtype">error::Code </td>
|
|
<td class="paramname"><em>error_code</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const std::string & </td>
|
|
<td class="paramname"><em>error_message</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>Create a status with the specified code, and error message. If "error_code == error::OK", error_message is ignored and a <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> object identical to Status::OK is constructed. </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../da/dc3/status_8cc_source.html#l00067">67</a> of file <a class="el" href="../../da/dc3/status_8cc_source.html">status.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a6c5c3c528296f2cb0dec56506cb8d3c3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c5c3c528296f2cb0dec56506cb8d3c3">◆ </a></span>ToString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">std::string shaka::Status::ToString </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<dl class="section return"><dt>Returns</dt><dd>A combination of the error code name and message. </dd></dl>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../da/dc3/status_8cc_source.html#l00081">81</a> of file <a class="el" href="../../da/dc3/status_8cc_source.html">status.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9c0536749c9abc21c1111e622de6b7c8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9c0536749c9abc21c1111e622de6b7c8">◆ </a></span>Update()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void shaka::Status::Update </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> </td>
|
|
<td class="paramname"><em>new_status</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
<p>If "ok()", stores "new_status" into *this. If "!ok()", preserves the current "error_code()/error_message()",</p>
|
|
<p>Convenient way of keeping track of the first error encountered. Instead of: if (overall_status.ok()) overall_status = new_status Use: overall_status.Update(new_status); </p>
|
|
|
|
<p class="definition">Definition at line <a class="el" href="../../da/dc3/status_8cc_source.html#l00076">76</a> of file <a class="el" href="../../da/dc3/status_8cc_source.html">status.cc</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>packager/<a class="el" href="../../d1/d13/status_8h_source.html">status.h</a></li>
|
|
<li>packager/<a class="el" href="../../da/dc3/status_8cc_source.html">status.cc</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated on Wed Aug 15 2018 17:34:17 for Shaka Packager SDK by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.13
|
|
</small></address>
|
|
</body>
|
|
</html>
|