<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Orcus: orcus::xmlns_context 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">Orcus
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</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"><b>orcus</b></li><li class="navelem"><a class="el" href="classorcus_1_1xmlns__context.html">xmlns_context</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="classorcus_1_1xmlns__context-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">orcus::xmlns_context Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="xml__namespace_8hpp_source.html">xml_namespace.hpp</a>></code></p>
<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:a8d3f8d8db1d0ef90172afaae98828668"><td class="memItemLeft" align="right" valign="top"><a id="a8d3f8d8db1d0ef90172afaae98828668"></a>
 </td><td class="memItemRight" valign="bottom"><b>xmlns_context</b> (const <a class="el" href="classorcus_1_1xmlns__context.html">xmlns_context</a> &r)</td></tr>
<tr class="separator:a8d3f8d8db1d0ef90172afaae98828668"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab7de21185411435c094432c6dffbf0a6"><td class="memItemLeft" align="right" valign="top"><a id="ab7de21185411435c094432c6dffbf0a6"></a>
xmlns_id_t </td><td class="memItemRight" valign="bottom"><b>push</b> (const <a class="el" href="classorcus_1_1pstring.html">pstring</a> &key, const <a class="el" href="classorcus_1_1pstring.html">pstring</a> &uri)</td></tr>
<tr class="separator:ab7de21185411435c094432c6dffbf0a6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a32cddcca3cd059c8984ab886d5dcd579"><td class="memItemLeft" align="right" valign="top"><a id="a32cddcca3cd059c8984ab886d5dcd579"></a>
void </td><td class="memItemRight" valign="bottom"><b>pop</b> (const <a class="el" href="classorcus_1_1pstring.html">pstring</a> &key)</td></tr>
<tr class="separator:a32cddcca3cd059c8984ab886d5dcd579"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a39d5a9c9a9418bbbd974ffc24e5146fe"><td class="memItemLeft" align="right" valign="top">xmlns_id_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1xmlns__context.html#a39d5a9c9a9418bbbd974ffc24e5146fe">get</a> (const <a class="el" href="classorcus_1_1pstring.html">pstring</a> &key) const</td></tr>
<tr class="separator:a39d5a9c9a9418bbbd974ffc24e5146fe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1c78fd5f853234201c5fe09e7aaeba8e"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1xmlns__context.html#a1c78fd5f853234201c5fe09e7aaeba8e">get_index</a> (xmlns_id_t ns_id) const</td></tr>
<tr class="separator:a1c78fd5f853234201c5fe09e7aaeba8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3a279ceb8e0cf8f8b173a47326d9b8f1"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1xmlns__context.html#a3a279ceb8e0cf8f8b173a47326d9b8f1">get_short_name</a> (xmlns_id_t ns_id) const</td></tr>
<tr class="separator:a3a279ceb8e0cf8f8b173a47326d9b8f1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91204209e957764dc704299e15fd9813"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classorcus_1_1pstring.html">pstring</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1xmlns__context.html#a91204209e957764dc704299e15fd9813">get_alias</a> (xmlns_id_t ns_id) const</td></tr>
<tr class="separator:a91204209e957764dc704299e15fd9813"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96b34bc61668abaf1a6344661dabf439"><td class="memItemLeft" align="right" valign="top"><a id="a96b34bc61668abaf1a6344661dabf439"></a>
std::vector< xmlns_id_t > </td><td class="memItemRight" valign="bottom"><b>get_all_namespaces</b> () const</td></tr>
<tr class="separator:a96b34bc61668abaf1a6344661dabf439"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a155944672edefa236dba433fc9faff65"><td class="memItemLeft" align="right" valign="top"><a id="a155944672edefa236dba433fc9faff65"></a>
void </td><td class="memItemRight" valign="bottom"><b>dump</b> (std::ostream &os) const</td></tr>
<tr class="separator:a155944672edefa236dba433fc9faff65"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:aba67edbcaaa7259d9b505699f9d0a70d"><td class="memItemLeft" align="right" valign="top"><a id="aba67edbcaaa7259d9b505699f9d0a70d"></a>
class </td><td class="memItemRight" valign="bottom"><b>xmlns_repository</b></td></tr>
<tr class="separator:aba67edbcaaa7259d9b505699f9d0a70d"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>XML namespace context. A new context should be used for each xml stream since the namespace keys themselves are not interned. Don't hold an instance of this class any longer than the life cycle of the xml stream it is used in.</p>
<p>An empty key value is associated with a default namespace. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a39d5a9c9a9418bbbd974ffc24e5146fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a39d5a9c9a9418bbbd974ffc24e5146fe">◆ </a></span>get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xmlns_id_t orcus::xmlns_context::get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classorcus_1_1pstring.html">pstring</a> & </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the currnet namespace identifier for a specified namespace alias.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">key</td><td>namespace alias to get the current namespace identifier for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>current namespace identifier associated with the alias. </dd></dl>
</div>
</div>
<a id="a91204209e957764dc704299e15fd9813"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91204209e957764dc704299e15fd9813">◆ </a></span>get_alias()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classorcus_1_1pstring.html">pstring</a> orcus::xmlns_context::get_alias </td>
<td>(</td>
<td class="paramtype">xmlns_id_t </td>
<td class="paramname"><em>ns_id</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get an alias currently associated with a given namespace identifier.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ns_id</td><td>namespace identifier.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>alias name currently associted with the given namespace identifier, or an empty string if the given namespace is currently not associated with any aliases. </dd></dl>
</div>
</div>
<a id="a1c78fd5f853234201c5fe09e7aaeba8e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c78fd5f853234201c5fe09e7aaeba8e">◆ </a></span>get_index()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t orcus::xmlns_context::get_index </td>
<td>(</td>
<td class="paramtype">xmlns_id_t </td>
<td class="paramname"><em>ns_id</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a unique index value associated with a specified identifier. An index value is guaranteed to be unique regardless of contexts.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ns_id</td><td>a namespace identifier to obtain index for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>index value associated with the identifier. </dd></dl>
</div>
</div>
<a id="a3a279ceb8e0cf8f8b173a47326d9b8f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3a279ceb8e0cf8f8b173a47326d9b8f1">◆ </a></span>get_short_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string orcus::xmlns_context::get_short_name </td>
<td>(</td>
<td class="paramtype">xmlns_id_t </td>
<td class="paramname"><em>ns_id</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a 'short' name associated with a specified identifier. A short name is a string value conveniently short enough for display purposes, but still guaranteed to be unique to the identifier it is associated with.</p>
<p>Note that the <a class="el" href="classorcus_1_1xmlns__repository.html">xmlns_repository</a> class has method of the same name, and that method works identically to this method.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ns_id</td><td>a namespace identifier to obtain short name for.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>short name for the specified identifier. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jan 11 2019 05:05:19 for Orcus by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
