Page MenuHomec4science
Files F124423090

xml__utils_8h.html
No OneTemporary
Actions

File Metadata

Created
Sat, Aug 2, 10:08

xml__utils_8h.html
View Options

<!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>TXML2Bookstore(class): Src/xml_utils.h File 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">TXML2Bookstore(class)
</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="dir_413f4e031a85da0d68269c6fd2f76e1c.html">Src</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">xml_utils.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;tinyxml2/tinyxml2.h&quot;</code><br />
<code>#include &lt;string&gt;</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for xml_utils.h:</div>
<div class="dyncontent">
<div class="center"><img src="xml__utils_8h__incl.png" border="0" usemap="#_src_2xml__utils_8h" alt=""/></div>
<map name="_src_2xml__utils_8h" id="_src_2xml__utils_8h">
</map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="xml__utils_8h__dep__incl.png" border="0" usemap="#_src_2xml__utils_8hdep" alt=""/></div>
<map name="_src_2xml__utils_8hdep" id="_src_2xml__utils_8hdep">
<area shape="rect" id="node2" href="_book_8cpp.html" title="Src/Book.cpp" alt="" coords="5,80,107,107"/>
<area shape="rect" id="node3" href="_library_8cpp.html" title="Src/Library.cpp" alt="" coords="131,80,242,107"/>
<area shape="rect" id="node4" href="main_8cpp.html" title="Src/main.cpp" alt="" coords="267,80,365,107"/>
<area shape="rect" id="node5" href="xml__utils_8cpp.html" title="Src/xml_utils.cpp" alt="" coords="389,80,512,107"/>
</map>
</div>
</div>
<p><a href="xml__utils_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aad766222cc2affc14e1f112a6091df71"><td class="memItemLeft" align="right" valign="top">typedef const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a></td></tr>
<tr class="memdesc:aad766222cc2affc14e1f112a6091df71"><td class="mdescLeft">&#160;</td><td class="mdescRight">String type for TinyXML2. <a href="#aad766222cc2affc14e1f112a6091df71">More...</a><br /></td></tr>
<tr class="separator:aad766222cc2affc14e1f112a6091df71"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ab13269a7ab6468274d966a715e16c79d"><td class="memItemLeft" align="right" valign="top">tinyxml2::XMLDocument *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#ab13269a7ab6468274d966a715e16c79d">create_dom</a> (std::string file_name)</td></tr>
<tr class="separator:ab13269a7ab6468274d966a715e16c79d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adeff8ce99d030a5907d5bd7301283797"><td class="memItemLeft" align="right" valign="top">tinyxml2::XMLElement *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#adeff8ce99d030a5907d5bd7301283797">get_elem</a> (tinyxml2::XMLElement *p_parent, <a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a> name, bool mandatory=true, bool do_throw=true)</td></tr>
<tr class="separator:adeff8ce99d030a5907d5bd7301283797"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a30f6b4ea6a0475231cb2f0d6e462c5c7"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#a30f6b4ea6a0475231cb2f0d6e462c5c7">get_elem_val</a> (tinyxml2::XMLElement *p_parent, <a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a> name, bool mandatory=true, std::string default_val=&quot;&quot;)</td></tr>
<tr class="separator:a30f6b4ea6a0475231cb2f0d6e462c5c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0366eacc44f8a9e8506ebfd0ba74f999"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#a0366eacc44f8a9e8506ebfd0ba74f999">get_elem_int</a> (tinyxml2::XMLElement *p_parent, <a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a> name, bool mandatory=true, int default_val=0)</td></tr>
<tr class="separator:a0366eacc44f8a9e8506ebfd0ba74f999"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ad31bde4e74d5f7db5e1d7e440856ab"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#a0ad31bde4e74d5f7db5e1d7e440856ab">get_elem_dbl</a> (tinyxml2::XMLElement *p_parent, <a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a> name, bool mandatory=true, double default_val=0.0)</td></tr>
<tr class="separator:a0ad31bde4e74d5f7db5e1d7e440856ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa0dbaa9b5f43ff4335573aa2f86ef2dd"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#aa0dbaa9b5f43ff4335573aa2f86ef2dd">get_attr_val</a> (tinyxml2::XMLElement *p_elem, <a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a> name, bool mandatory=true, std::string default_val=&quot;&quot;)</td></tr>
<tr class="separator:aa0dbaa9b5f43ff4335573aa2f86ef2dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87c9bc43a64c33b7db0d3658cccf55cd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#a87c9bc43a64c33b7db0d3658cccf55cd">get_attr_int</a> (tinyxml2::XMLElement *p_elem, <a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a> name, bool mandatory=true, int default_val=0)</td></tr>
<tr class="separator:a87c9bc43a64c33b7db0d3658cccf55cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba62db46d12f520f0107d7515bee26f8"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#aba62db46d12f520f0107d7515bee26f8">get_attr_dbl</a> (tinyxml2::XMLElement *p_elem, <a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a> name, bool mandatory=true, double default_val=0.0)</td></tr>
<tr class="separator:aba62db46d12f520f0107d7515bee26f8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71a56517605ba9378f3c98492190faba"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#a71a56517605ba9378f3c98492190faba">get_attr_yesno</a> (tinyxml2::XMLElement *p_elem, <a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a> name, bool mandatory=true, std::string default_val=&quot;no&quot;)</td></tr>
<tr class="separator:a71a56517605ba9378f3c98492190faba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad493fad0bebc3c530feedd90e8df109b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xml__utils_8h.html#ad493fad0bebc3c530feedd90e8df109b">parse_xml</a> (std::string file_name, int max_level=-1)</td></tr>
<tr class="separator:ad493fad0bebc3c530feedd90e8df109b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="aad766222cc2affc14e1f112a6091df71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad766222cc2affc14e1f112a6091df71">&#9670;&nbsp;</a></span>xml_string</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef const char* <a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>String type for TinyXML2. </p>
<p class="definition">Definition at line <a class="el" href="xml__utils_8h_source.html#l00015">15</a> of file <a class="el" href="xml__utils_8h_source.html">xml_utils.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ab13269a7ab6468274d966a715e16c79d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab13269a7ab6468274d966a715e16c79d">&#9670;&nbsp;</a></span>create_dom()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">tinyxml2::XMLDocument* create_dom </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>file_name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads an XML file and builds the DOM. Throws an error message if the XML file has syntax errors.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_name</td><td>XML file name to parse. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="xml__utils_8cpp_source.html#l00016">16</a> of file <a class="el" href="xml__utils_8cpp_source.html">xml_utils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="_library_8cpp_source.html#l00014">Library::Library()</a>, and <a class="el" href="xml__utils_8cpp_source.html#l00298">parse_xml()</a>.</p>
</div>
</div>
<a id="aba62db46d12f520f0107d7515bee26f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aba62db46d12f520f0107d7515bee26f8">&#9670;&nbsp;</a></span>get_attr_dbl()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double get_attr_dbl </td>
<td>(</td>
<td class="paramtype">tinyxml2::XMLElement *&#160;</td>
<td class="paramname"><em>p_elem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a>&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>mandatory</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>default_val</em> = <code>0.0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the double value of an attribute. Throws an exception if attribute is mandatory and is missing or if the value is not a double.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_elem</td><td>Pointer to XML element that hosts the attribute. </td></tr>
<tr><td class="paramname">name</td><td>Attribute name. </td></tr>
<tr><td class="paramname">mandatory</td><td>Is the attribute mandatory? </td></tr>
<tr><td class="paramname">default_val</td><td>If not, use the default value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Attribute value from XML DOM or default value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="xml__utils_8cpp_source.html#l00192">192</a> of file <a class="el" href="xml__utils_8cpp_source.html">xml_utils.cpp</a>.</p>
</div>
</div>
<a id="a87c9bc43a64c33b7db0d3658cccf55cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87c9bc43a64c33b7db0d3658cccf55cd">&#9670;&nbsp;</a></span>get_attr_int()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int get_attr_int </td>
<td>(</td>
<td class="paramtype">tinyxml2::XMLElement *&#160;</td>
<td class="paramname"><em>p_elem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a>&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>mandatory</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>default_val</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the integer value of an attribute. Throws an exception if attribute is mandatory and is missing or if the value is not an integer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_elem</td><td>Pointer to XML element that hosts the attribute. </td></tr>
<tr><td class="paramname">name</td><td>Attribute name. </td></tr>
<tr><td class="paramname">mandatory</td><td>Is the attribute mandatory? </td></tr>
<tr><td class="paramname">default_val</td><td>If not, use the default value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Attribute value from XML DOM or default value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="xml__utils_8cpp_source.html#l00166">166</a> of file <a class="el" href="xml__utils_8cpp_source.html">xml_utils.cpp</a>.</p>
</div>
</div>
<a id="aa0dbaa9b5f43ff4335573aa2f86ef2dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa0dbaa9b5f43ff4335573aa2f86ef2dd">&#9670;&nbsp;</a></span>get_attr_val()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string get_attr_val </td>
<td>(</td>
<td class="paramtype">tinyxml2::XMLElement *&#160;</td>
<td class="paramname"><em>p_elem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a>&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>mandatory</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>default_val</em> = <code>&quot;&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the string value of an attribute. Throws an exception if attribute is mandatory and is missing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_parent</td><td>Pointer XML element that hosts the attribute. </td></tr>
<tr><td class="paramname">name</td><td>Attribute name. </td></tr>
<tr><td class="paramname">mandatory</td><td>Is the attribute mandatory? </td></tr>
<tr><td class="paramname">default_val</td><td>If not mandatory, use the default value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Attribute value from XML DOM or default value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="xml__utils_8cpp_source.html#l00142">142</a> of file <a class="el" href="xml__utils_8cpp_source.html">xml_utils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="xml__utils_8cpp_source.html#l00218">get_attr_yesno()</a>.</p>
</div>
</div>
<a id="a71a56517605ba9378f3c98492190faba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71a56517605ba9378f3c98492190faba">&#9670;&nbsp;</a></span>get_attr_yesno()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool get_attr_yesno </td>
<td>(</td>
<td class="paramtype">tinyxml2::XMLElement *&#160;</td>
<td class="paramname"><em>p_elem</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a>&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>mandatory</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>default_val</em> = <code>&quot;no&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the yes/no value of an attribute. Throws an exception if attribute is mandatory and is missing or if the value is not "yes" or "no".</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_elem</td><td>Pointer to XML element that hosts the attribute. </td></tr>
<tr><td class="paramname">name</td><td>Attribute name. </td></tr>
<tr><td class="paramname">mandatory</td><td>Is the attribute mandatory? </td></tr>
<tr><td class="paramname">default_val</td><td>If not, use the default value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Attribute value from XML DOM or default value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="xml__utils_8cpp_source.html#l00218">218</a> of file <a class="el" href="xml__utils_8cpp_source.html">xml_utils.cpp</a>.</p>
<p class="reference">References <a class="el" href="xml__utils_8cpp_source.html#l00142">get_attr_val()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="xml__utils_8h_a71a56517605ba9378f3c98492190faba_cgraph.png" border="0" usemap="#xml__utils_8h_a71a56517605ba9378f3c98492190faba_cgraph" alt=""/></div>
<map name="xml__utils_8h_a71a56517605ba9378f3c98492190faba_cgraph" id="xml__utils_8h_a71a56517605ba9378f3c98492190faba_cgraph">
<area shape="rect" id="node2" href="xml__utils_8cpp.html#a20d88a02adadd291685377e894e70731" title="get_attr_val" alt="" coords="161,5,249,32"/>
</map>
</div>
</div>
</div>
<a id="adeff8ce99d030a5907d5bd7301283797"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adeff8ce99d030a5907d5bd7301283797">&#9670;&nbsp;</a></span>get_elem()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">tinyxml2::XMLElement* get_elem </td>
<td>(</td>
<td class="paramtype">tinyxml2::XMLElement *&#160;</td>
<td class="paramname"><em>p_parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a>&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>mandatory</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>do_throw</em> = <code>true</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets a pointer to a sub-element of an element.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_parent</td><td>Pointer to parent XML element. </td></tr>
<tr><td class="paramname">name</td><td>Element name. </td></tr>
<tr><td class="paramname">mandatory</td><td>Is the element mandatory? </td></tr>
<tr><td class="paramname">do_throw</td><td>Flag. If true, throws an exception if element is missing. If false, returns a null pointer if element is missing.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to element. </dd></dl>
<p class="definition">Definition at line <a class="el" href="xml__utils_8cpp_source.html#l00039">39</a> of file <a class="el" href="xml__utils_8cpp_source.html">xml_utils.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="xml__utils_8cpp_source.html#l00115">get_elem_dbl()</a>, <a class="el" href="xml__utils_8cpp_source.html#l00088">get_elem_int()</a>, <a class="el" href="xml__utils_8cpp_source.html#l00060">get_elem_val()</a>, and <a class="el" href="_library_8cpp_source.html#l00014">Library::Library()</a>.</p>
</div>
</div>
<a id="a0ad31bde4e74d5f7db5e1d7e440856ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ad31bde4e74d5f7db5e1d7e440856ab">&#9670;&nbsp;</a></span>get_elem_dbl()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double get_elem_dbl </td>
<td>(</td>
<td class="paramtype">tinyxml2::XMLElement *&#160;</td>
<td class="paramname"><em>p_parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a>&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>mandatory</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>default_val</em> = <code>0.0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the double value of an element. Throws an exception if element is mandatory or is missing or if the value is not a double.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_parent</td><td>Pointer to parent XML element. </td></tr>
<tr><td class="paramname">name</td><td>Element name. </td></tr>
<tr><td class="paramname">mandatory</td><td>Is the element mandatory? </td></tr>
<tr><td class="paramname">default_val</td><td>If not, use the default value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Element value from XML DOM or default value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="xml__utils_8cpp_source.html#l00115">115</a> of file <a class="el" href="xml__utils_8cpp_source.html">xml_utils.cpp</a>.</p>
<p class="reference">References <a class="el" href="xml__utils_8cpp_source.html#l00039">get_elem()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="xml__utils_8h_a0ad31bde4e74d5f7db5e1d7e440856ab_cgraph.png" border="0" usemap="#xml__utils_8h_a0ad31bde4e74d5f7db5e1d7e440856ab_cgraph" alt=""/></div>
<map name="xml__utils_8h_a0ad31bde4e74d5f7db5e1d7e440856ab_cgraph" id="xml__utils_8h_a0ad31bde4e74d5f7db5e1d7e440856ab_cgraph">
<area shape="rect" id="node2" href="xml__utils_8cpp.html#a99aedcc5eff96fd8ece918d6214e3342" title="get_elem" alt="" coords="152,5,227,32"/>
</map>
</div>
</div>
</div>
<a id="a0366eacc44f8a9e8506ebfd0ba74f999"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0366eacc44f8a9e8506ebfd0ba74f999">&#9670;&nbsp;</a></span>get_elem_int()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int get_elem_int </td>
<td>(</td>
<td class="paramtype">tinyxml2::XMLElement *&#160;</td>
<td class="paramname"><em>p_parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a>&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>mandatory</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>default_val</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the integer value of an element. Throws an exception if element is mandatory and is missing or if the value is not an integer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_parent</td><td>Pointer to parent XML element. </td></tr>
<tr><td class="paramname">name</td><td>Element name. </td></tr>
<tr><td class="paramname">mandatory</td><td>Is the element mandatory? </td></tr>
<tr><td class="paramname">default_val</td><td>If not, use the default value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Element value from XML DOM or default value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="xml__utils_8cpp_source.html#l00088">88</a> of file <a class="el" href="xml__utils_8cpp_source.html">xml_utils.cpp</a>.</p>
<p class="reference">References <a class="el" href="xml__utils_8cpp_source.html#l00039">get_elem()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="xml__utils_8h_a0366eacc44f8a9e8506ebfd0ba74f999_cgraph.png" border="0" usemap="#xml__utils_8h_a0366eacc44f8a9e8506ebfd0ba74f999_cgraph" alt=""/></div>
<map name="xml__utils_8h_a0366eacc44f8a9e8506ebfd0ba74f999_cgraph" id="xml__utils_8h_a0366eacc44f8a9e8506ebfd0ba74f999_cgraph">
<area shape="rect" id="node2" href="xml__utils_8cpp.html#a99aedcc5eff96fd8ece918d6214e3342" title="get_elem" alt="" coords="149,5,224,32"/>
</map>
</div>
</div>
</div>
<a id="a30f6b4ea6a0475231cb2f0d6e462c5c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a30f6b4ea6a0475231cb2f0d6e462c5c7">&#9670;&nbsp;</a></span>get_elem_val()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string get_elem_val </td>
<td>(</td>
<td class="paramtype">tinyxml2::XMLElement *&#160;</td>
<td class="paramname"><em>p_parent</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xml__utils_8h.html#aad766222cc2affc14e1f112a6091df71">xml_string</a>&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>mandatory</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>default_val</em> = <code>&quot;&quot;</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Extracts the string value of an element. Throws an exception if element is mandatory and is missing.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p_parent</td><td>Pointer to parent XML element. </td></tr>
<tr><td class="paramname">name</td><td>Element name. </td></tr>
<tr><td class="paramname">mandatory</td><td>Is the element mandatory? </td></tr>
<tr><td class="paramname">default_val</td><td>If not mandatory, use the default value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Element value from XML DOM or default value. </dd></dl>
<p class="definition">Definition at line <a class="el" href="xml__utils_8cpp_source.html#l00060">60</a> of file <a class="el" href="xml__utils_8cpp_source.html">xml_utils.cpp</a>.</p>
<p class="reference">References <a class="el" href="xml__utils_8cpp_source.html#l00039">get_elem()</a>.</p>
<p class="reference">Referenced by <a class="el" href="_book_8cpp_source.html#l00013">Book::Book()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="xml__utils_8h_a30f6b4ea6a0475231cb2f0d6e462c5c7_cgraph.png" border="0" usemap="#xml__utils_8h_a30f6b4ea6a0475231cb2f0d6e462c5c7_cgraph" alt=""/></div>
<map name="xml__utils_8h_a30f6b4ea6a0475231cb2f0d6e462c5c7_cgraph" id="xml__utils_8h_a30f6b4ea6a0475231cb2f0d6e462c5c7_cgraph">
<area shape="rect" id="node2" href="xml__utils_8cpp.html#a99aedcc5eff96fd8ece918d6214e3342" title="get_elem" alt="" coords="151,5,225,32"/>
</map>
</div>
</div>
</div>
<a id="ad493fad0bebc3c530feedd90e8df109b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad493fad0bebc3c530feedd90e8df109b">&#9670;&nbsp;</a></span>parse_xml()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void parse_xml </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>file_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>max_level</em> = <code>-1</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads an XML file, builds the DOM and displays the full DOM content. Throws an error message if the XML file has syntax errors.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">file_name</td><td>XML file name to parse. </td></tr>
<tr><td class="paramname">max_level</td><td>Stop at level (default: all levels). </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="xml__utils_8cpp_source.html#l00298">298</a> of file <a class="el" href="xml__utils_8cpp_source.html">xml_utils.cpp</a>.</p>
<p class="reference">References <a class="el" href="xml__utils_8cpp_source.html#l00016">create_dom()</a>, and <a class="el" href="xml__utils_8cpp_source.html#l00246">parse_level()</a>.</p>
<p class="reference">Referenced by <a class="el" href="main_8cpp_source.html#l00018">main()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="xml__utils_8h_ad493fad0bebc3c530feedd90e8df109b_cgraph.png" border="0" usemap="#xml__utils_8h_ad493fad0bebc3c530feedd90e8df109b_cgraph" alt=""/></div>
<map name="xml__utils_8h_ad493fad0bebc3c530feedd90e8df109b_cgraph" id="xml__utils_8h_ad493fad0bebc3c530feedd90e8df109b_cgraph">
<area shape="rect" id="node2" href="xml__utils_8cpp.html#ab13269a7ab6468274d966a715e16c79d" title="create_dom" alt="" coords="136,5,227,32"/>
<area shape="rect" id="node3" href="xml__utils_8cpp.html#aa528973ddad0859a6a4d349c35715d9d" title="parse_level" alt="" coords="138,56,225,83"/>
</map>
</div>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

Event Timeline

c4science · Help