<!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>Orcus: orcus::tokens 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.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"><b>orcus</b></li><li class="navelem"><a class="el" href="classorcus_1_1tokens.html">tokens</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classorcus_1_1tokens-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">orcus::tokens 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:aae39d0e9ae49346a5a974c0e6da037d1"><td class="memItemLeft" align="right" valign="top"><a id="aae39d0e9ae49346a5a974c0e6da037d1"></a>
 </td><td class="memItemRight" valign="bottom"><b>tokens</b> (const char **token_names, size_t token_name_count)</td></tr>
<tr class="separator:aae39d0e9ae49346a5a974c0e6da037d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2c0d41a883fb981c9d46dda759654f6b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1tokens.html#a2c0d41a883fb981c9d46dda759654f6b">is_valid_token</a> (xml_token_t token) const</td></tr>
<tr class="separator:a2c0d41a883fb981c9d46dda759654f6b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b651671dd03ee3c65743c66c52e3159"><td class="memItemLeft" align="right" valign="top">xml_token_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1tokens.html#a5b651671dd03ee3c65743c66c52e3159">get_token</a> (const <a class="el" href="classorcus_1_1pstring.html">pstring</a> &name) const</td></tr>
<tr class="separator:a5b651671dd03ee3c65743c66c52e3159"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6e7ecc168fa24e850bfe3ad1395cbf1"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classorcus_1_1tokens.html#ac6e7ecc168fa24e850bfe3ad1395cbf1">get_token_name</a> (xml_token_t token) const</td></tr>
<tr class="separator:ac6e7ecc168fa24e850bfe3ad1395cbf1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5b651671dd03ee3c65743c66c52e3159"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5b651671dd03ee3c65743c66c52e3159">◆ </a></span>get_token()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xml_token_t orcus::tokens::get_token </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classorcus_1_1pstring.html">pstring</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get token from a specified name.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>textural token name</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>token value representing the given textural token. </dd></dl>
</div>
</div>
<a id="ac6e7ecc168fa24e850bfe3ad1395cbf1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6e7ecc168fa24e850bfe3ad1395cbf1">◆ </a></span>get_token_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* orcus::tokens::get_token_name </td>
<td>(</td>
<td class="paramtype">xml_token_t </td>
<td class="paramname"><em>token</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get textural token name from a token value.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">token</td><td>numeric token value</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>textural token name, or empty string in case the given token is not valid. </dd></dl>
</div>
</div>
<a id="a2c0d41a883fb981c9d46dda759654f6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c0d41a883fb981c9d46dda759654f6b">◆ </a></span>is_valid_token()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool orcus::tokens::is_valid_token </td>
<td>(</td>
<td class="paramtype">xml_token_t </td>
<td class="paramname"><em>token</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a token returned from <a class="el" href="classorcus_1_1tokens.html#a5b651671dd03ee3c65743c66c52e3159">get_token()</a> method is valid.</p>
<dl class="section return"><dt>Returns</dt><dd>true if valid, false otherwise. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Feb 9 2019 16:54:03 for Orcus 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>
