Mirror-Tools
/
shaka-packager
mirror of https://github.com/shaka-project/shaka-packager.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
shaka-packager/docs/d2/d20/classshaka_1_1Status.html

311 lines
19 KiB
HTML
Raw Normal View History

Generate documents for commit 21b0ca6ea5a232646f3bb8bd59e46ab46aac71f5
2017-09-20 02:35:05 +00:00
<!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.6"/>
<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/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 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.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="../../index.html"><span>Main&#160;Page</span></a></li>
<li><a href="../../namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="../../annotated.html"><span>Classes</span></a></li>
<li><a href="../../files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="../../search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="../../search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="../../annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="../../classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="../../hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="../../functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Friends</a></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> &#124;
<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 class="anchor" id="a12c04257e2480e0ce87cd16b944921d0"></a>
&#160;</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">&#160;</td><td class="mdescRight">Creates a "successful" status. <br/></td></tr>
<tr class="separator:a12c04257e2480e0ce87cd16b944921d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2fa2116c9e12215a4e3430b362ba622b"><td class="memItemLeft" align="right" valign="top">&#160;</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 &amp;error_message)</td></tr>
<tr class="separator:a2fa2116c9e12215a4e3430b362ba622b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5a0cbdf79d591ae56af4913ec33f250"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d20/classshaka_1_1Status.html#ac5a0cbdf79d591ae56af4913ec33f250">SetError</a> (error::Code error_code, const std::string &amp;error_message)</td></tr>
<tr class="separator:ac5a0cbdf79d591ae56af4913ec33f250"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a073aa1a10d4d005af861079e7319d3fa"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d20/classshaka_1_1Status.html#a073aa1a10d4d005af861079e7319d3fa">Update</a> (const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> &amp;new_status)</td></tr>
<tr class="separator:a073aa1a10d4d005af861079e7319d3fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a022f6fc5d4756ce2cb2b586d8c40f145"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a022f6fc5d4756ce2cb2b586d8c40f145"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d20/classshaka_1_1Status.html#a022f6fc5d4756ce2cb2b586d8c40f145">Clear</a> ()</td></tr>
<tr class="memdesc:a022f6fc5d4756ce2cb2b586d8c40f145"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear this status object to contain the OK code and no error message. <br/></td></tr>
<tr class="separator:a022f6fc5d4756ce2cb2b586d8c40f145"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a879f01400744113633a0d1c00eadba5d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a879f01400744113633a0d1c00eadba5d"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>ok</b> () const </td></tr>
<tr class="separator:a879f01400744113633a0d1c00eadba5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0d0baab78cde0a03c7c6a650906586c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0d0baab78cde0a03c7c6a650906586c"></a>
error::Code&#160;</td><td class="memItemRight" valign="bottom"><b>error_code</b> () const </td></tr>
<tr class="separator:af0d0baab78cde0a03c7c6a650906586c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a435e0c0d044ca42c9f021deefd8795ad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a435e0c0d044ca42c9f021deefd8795ad"></a>
const std::string &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>error_message</b> () const </td></tr>
<tr class="separator:a435e0c0d044ca42c9f021deefd8795ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af9038f8cf07a413d1f03587302be75c6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af9038f8cf07a413d1f03587302be75c6"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator==</b> (const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> &amp;x) const </td></tr>
<tr class="separator:af9038f8cf07a413d1f03587302be75c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28fb0f06d4b508b97d2f0d535575efee"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28fb0f06d4b508b97d2f0d535575efee"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><b>operator!=</b> (const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> &amp;x) const </td></tr>
<tr class="separator:a28fb0f06d4b508b97d2f0d535575efee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a87de3b647b2eb6fb5dcd61efbca5cd"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d20/classshaka_1_1Status.html#a8a87de3b647b2eb6fb5dcd61efbca5cd">Matches</a> (const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> &amp;x) const </td></tr>
<tr class="separator:a8a87de3b647b2eb6fb5dcd61efbca5cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b9c6f6e38d23dc6839bd275b0d15500"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d2/d20/classshaka_1_1Status.html#a5b9c6f6e38d23dc6839bd275b0d15500">ToString</a> () const </td></tr>
<tr class="separator:a5b9c6f6e38d23dc6839bd275b0d15500"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a43e0fe397c0baf74b1796d433a54c5c7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a43e0fe397c0baf74b1796d433a54c5c7"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>Swap</b> (<a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> *other)</td></tr>
<tr class="separator:a43e0fe397c0baf74b1796d433a54c5c7"><td class="memSeparator" colspan="2">&#160;</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 class="anchor" id="ac1d0f21a89f2db1989372e63ec172ad3"></a>
static const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>OK</b> = <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>(error::OK, &quot;&quot;)</td></tr>
<tr class="separator:ac1d0f21a89f2db1989372e63ec172ad3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad05bbde77c2a2bb3ca1ee26184fda8c5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad05bbde77c2a2bb3ca1ee26184fda8c5"></a>
static const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>&#160;</td><td class="memItemRight" valign="bottom"><b>UNKNOWN</b> = <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a>(error::UNKNOWN, &quot;&quot;)</td></tr>
<tr class="separator:ad05bbde77c2a2bb3ca1ee26184fda8c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p>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 &amp; Destructor Documentation</h2>
<a class="anchor" id="a2fa2116c9e12215a4e3430b362ba622b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">shaka::Status::Status </td>
<td>(</td>
<td class="paramtype">error::Code&#160;</td>
<td class="paramname"><em>error_code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>error_message</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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>Definition at line <a class="el" href="../../d1/d13/status_8h_source.html#l00118">118</a> of file <a class="el" href="../../d1/d13/status_8h_source.html">status.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8a87de3b647b2eb6fb5dcd61efbca5cd"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool shaka::Status::Matches </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> &amp;&#160;</td>
<td class="paramname"><em>x</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true iff this has the same error_code as "x", i.e., the two <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> objects are identical except possibly for the error message. </dd></dl>
<p>Definition at line <a class="el" href="../../d1/d13/status_8h_source.html#l00175">175</a> of file <a class="el" href="../../d1/d13/status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac5a0cbdf79d591ae56af4913ec33f250"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void shaka::Status::SetError </td>
<td>(</td>
<td class="paramtype">error::Code&#160;</td>
<td class="paramname"><em>error_code</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string &amp;&#160;</td>
<td class="paramname"><em>error_message</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Store the specified error in this <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> object. 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>Definition at line <a class="el" href="../../d1/d13/status_8h_source.html#l00135">135</a> of file <a class="el" href="../../d1/d13/status_8h_source.html">status.h</a>.</p>
</div>
</div>
<a class="anchor" id="a5b9c6f6e38d23dc6839bd275b0d15500"></a>
<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>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>
<a class="anchor" id="a073aa1a10d4d005af861079e7319d3fa"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void shaka::Status::Update </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="../../d2/d20/classshaka_1_1Status.html">Status</a> &amp;&#160;</td>
<td class="paramname"><em>new_status</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </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>Definition at line <a class="el" href="../../d1/d13/status_8h_source.html#l00152">152</a> of file <a class="el" href="../../d1/d13/status_8h_source.html">status.h</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 Tue Sep 19 2017 19:34:15 for Shaka Packager SDK by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="../../doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>