<!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"/>
<title>C++ API frePPLe: frepple::utils::XMLEscape Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="../styles.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="container">
<div id="menubar">
<div id="logo" align="center">
<br/><img src='../frepple.bmp' alt="frepple" /><br/>
<a href='http://www.frepple.com/'>
<strong>a Free<br/>Production Planning<br/>Library</strong>
</a>
</div>
<div id="menu">
<br/>
<h3><a href='../Main/HomePage.html'>Main</a></h3>
<h3><a href='../UI/Main.html'>User Manual</a></h3>
<h3><a href='../Tutorial/Main.html'>Tutorial</a></h3>
<h3><a href='../Frepple/Main.html'>Reference Manual</a></h3>
<h3><a href='../Main/FAQ.html'>FAQ</a></h3>
<h3><a href='index.html'>C++ API</a></h3>
<br/>
</div>
</div>
<div id="content">
<br/>
<!-- Generated by Doxygen 1.6.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</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><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00256.html">frepple</a>::<a class="el" href="a00257.html">utils</a>::<a class="el" href="a00185.html">XMLEscape</a>
</div>
</div>
<div class="contents">
<h1>frepple::utils::XMLEscape Class Reference</h1><!-- doxytag: class="frepple::utils::XMLEscape" -->
<p><code>#include <<a class="el" href="a00252_source.html">utils.h</a>></code></p>
<p><a href="a00654.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00185.html#a0d012fffaad248c146a9ac6e7e549017">XMLEscape</a> (const string &p)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00185.html#a37fe63f07c9a48b1e886b10283d58521">XMLEscape</a> (const char *p)</td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ostream & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00185.html#aa37a430d7422bbd13bc71fe16f0d1994">operator<<</a> (ostream &, const <a class="el" href="a00185.html">XMLEscape</a> &)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>@ brief This utility class escapes special characters from a string.</p>
<p>The following characters are replaced:</p>
<ul>
<li>&: replaced with &</li>
<li><: replaced with <</li>
<li>>: replaced with ></li>
<li>: replaced with "</li>
<li>': replaced with '</li>
<li>all other characters are left unchanged The reverse process of un-escaping the special character sequences is taken care of by the Xerces library.</li>
</ul>
<p>This class works fine with UTF-8 and single-byte encodings, but will NOT work with other multibyte encodings (such as UTF-116 or UTF-32). </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02102">2102</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a37fe63f07c9a48b1e886b10283d58521"></a><!-- doxytag: member="frepple::utils::XMLEscape::XMLEscape" ref="a37fe63f07c9a48b1e886b10283d58521" args="(const char *p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::XMLEscape::XMLEscape </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>p</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00252_source.html#l02108">2108</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a0d012fffaad248c146a9ac6e7e549017"></a><!-- doxytag: member="frepple::utils::XMLEscape::XMLEscape" ref="a0d012fffaad248c146a9ac6e7e549017" args="(const string &p)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::XMLEscape::XMLEscape </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>p</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00252_source.html#l02109">2109</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="aa37a430d7422bbd13bc71fe16f0d1994"></a><!-- doxytag: member="frepple::utils::XMLEscape::operator<<" ref="aa37a430d7422bbd13bc71fe16f0d1994" args="(ostream &, const XMLEscape &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ostream& operator<< </td>
<td>(</td>
<td class="paramtype">ostream & </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00185.html">XMLEscape</a> & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [friend]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00252_source.html">utils.h</a></li>
</ul>
</div>
<hr size="1"/><address style="align: right;"><small>Documentation generated for frePPLe by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"/></a></small></address>
</div>
</div>
</body>
</html>
