<!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::Attribute 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="a00002.html">Attribute</a>
</div>
</div>
<div class="contents">
<h1>frepple::utils::Attribute Class Reference</h1><!-- doxytag: class="frepple::utils::Attribute" -->
<p>A class to model keyword instances.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00252_source.html">utils.h</a>></code></p>
<p><a href="a00555.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="a00002.html#a8a00ddd26e962f7814111cd6905d9f5d">Attribute</a> (const <a class="el" href="a00002.html">Attribute</a> &o)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#aaf0ae45db5180e03f627eb00e8290c69">Attribute</a> (const char *c)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#a962d0fb008ae2cff4a0ceee14c74778a">Attribute</a> (const string &n)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#a514a22f750cb114a66270370caa4b423">Attribute</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00257.html#af8a429831281b355afd656cb83d31443">hashtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#acf0a89e3395a64f5a9ad10c0a71d6e67">getHash</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#af7828ecc0c5dd9c5c9569fd197514430">getName</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#a1dd91e5172a66ccc4529da12a82c5e28">isA</a> (const <a class="el" href="a00096.html">Keyword</a> *t) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#aebffce6c4fcf1696ca34f63f2b6ee091">isA</a> (const <a class="el" href="a00096.html">Keyword</a> &t) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#a1a7be81a0747a8396b88f6c98e82c3af">operator<</a> (const <a class="el" href="a00002.html">Attribute</a> &o) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#a9fbf1d530432eb67aa182d8e619340b4">operator==</a> (const string o) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#a24e436e226c1a669dc01903d44d47d1a">reset</a> (const XMLCh *const c)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00002.html#abbcf5dd7bec9a180161fa2353e4c5eb3">reset</a> (const char *const c)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A class to model keyword instances. </p>
<p>The class uses hashes to do a fast comparison with the set of keywords. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02573">2573</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a514a22f750cb114a66270370caa4b423"></a><!-- doxytag: member="frepple::utils::Attribute::Attribute" ref="a514a22f750cb114a66270370caa4b423" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::Attribute::Attribute </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Default constructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02587">2587</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a962d0fb008ae2cff4a0ceee14c74778a"></a><!-- doxytag: member="frepple::utils::Attribute::Attribute" ref="a962d0fb008ae2cff4a0ceee14c74778a" args="(const string &n)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::Attribute::Attribute </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>n</em></td>
<td> ) </td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02590">2590</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="aaf0ae45db5180e03f627eb00e8290c69"></a><!-- doxytag: member="frepple::utils::Attribute::Attribute" ref="aaf0ae45db5180e03f627eb00e8290c69" args="(const char *c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::Attribute::Attribute </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>c</em></td>
<td> ) </td>
<td><code> [inline, explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02594">2594</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a8a00ddd26e962f7814111cd6905d9f5d"></a><!-- doxytag: member="frepple::utils::Attribute::Attribute" ref="a8a00ddd26e962f7814111cd6905d9f5d" args="(const Attribute &o)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">frepple::utils::Attribute::Attribute </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname"> <em>o</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Copy constructor. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02597">2597</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acf0a89e3395a64f5a9ad10c0a71d6e67"></a><!-- doxytag: member="frepple::utils::Attribute::getHash" ref="acf0a89e3395a64f5a9ad10c0a71d6e67" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00257.html#af8a429831281b355afd656cb83d31443">hashtype</a> frepple::utils::Attribute::getHash </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the hash value of this tag. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02600">2600</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="af7828ecc0c5dd9c5c9569fd197514430"></a><!-- doxytag: member="frepple::utils::Attribute::getName" ref="af7828ecc0c5dd9c5c9569fd197514430" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * frepple::utils::Attribute::getName </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the element name. Since this method involves a lookup in a table with Keywords, it has some performance impact and should be avoided where possible. Only the hash of an element can efficiently be retrieved. </p>
<p>Definition at line <a class="el" href="a00255_source.html#l00668">668</a> of file <a class="el" href="a00255_source.html">xmlparser.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1dd91e5172a66ccc4529da12a82c5e28"></a><!-- doxytag: member="frepple::utils::Attribute::isA" ref="a1dd91e5172a66ccc4529da12a82c5e28" args="(const Keyword *t) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::utils::Attribute::isA </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00096.html">Keyword</a> * </td>
<td class="paramname"> <em>t</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true when this element is an instance of this tag. This method doesn't involve a string comparison and is extremely efficient. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02631">2631</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="aebffce6c4fcf1696ca34f63f2b6ee091"></a><!-- doxytag: member="frepple::utils::Attribute::isA" ref="aebffce6c4fcf1696ca34f63f2b6ee091" args="(const Keyword &t) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::utils::Attribute::isA </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00096.html">Keyword</a> & </td>
<td class="paramname"> <em>t</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true when this element is an instance of this tag. This method doesn't involve a string comparison and is extremely efficient. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02627">2627</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a1a7be81a0747a8396b88f6c98e82c3af"></a><!-- doxytag: member="frepple::utils::Attribute::operator<" ref="a1a7be81a0747a8396b88f6c98e82c3af" args="(const Attribute &o) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::utils::Attribute::operator< </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname"> <em>o</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Comparison operator. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02634">2634</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a9fbf1d530432eb67aa182d8e619340b4"></a><!-- doxytag: member="frepple::utils::Attribute::operator==" ref="a9fbf1d530432eb67aa182d8e619340b4" args="(const string o) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool frepple::utils::Attribute::operator== </td>
<td>(</td>
<td class="paramtype">const string </td>
<td class="paramname"> <em>o</em></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>String comparison. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02637">2637</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a24e436e226c1a669dc01903d44d47d1a"></a><!-- doxytag: member="frepple::utils::Attribute::reset" ref="a24e436e226c1a669dc01903d44d47d1a" args="(const XMLCh *const c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::utils::Attribute::reset </td>
<td>(</td>
<td class="paramtype">const XMLCh *const </td>
<td class="paramname"> <em>c</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns this tag. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02610">2610</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="abbcf5dd7bec9a180161fa2353e4c5eb3"></a><!-- doxytag: member="frepple::utils::Attribute::reset" ref="abbcf5dd7bec9a180161fa2353e4c5eb3" args="(const char *const c)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::utils::Attribute::reset </td>
<td>(</td>
<td class="paramtype">const char *const </td>
<td class="paramname"> <em>c</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns this tag. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l02603">2603</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a00252_source.html">utils.h</a></li>
<li><a class="el" href="a00255_source.html">xmlparser.cpp</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>
