<!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::HasDescription 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="a00082.html">HasDescription</a>
</div>
</div>
<div class="contents">
<h1>frepple::utils::HasDescription Class Reference</h1><!-- doxytag: class="frepple::utils::HasDescription" -->
<p>This is a decorator class for the main objects.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00252_source.html">utils.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for frepple::utils::HasDescription:</div>
<div class="dynsection">
<div class="center"><img src="a00587.png" border="0" usemap="#frepple_1_1utils_1_1_has_description_inherit__map" alt="Inheritance graph"/></div>
<map name="frepple_1_1utils_1_1_has_description_inherit__map" id="frepple_1_1utils_1_1_has_description_inherit__map">
<area shape="rect" id="node3" href="a00008.html" title="A buffer represents a combination of a item and location.  It is the entity for keeping..." alt="" coords="256,87,355,115"/>
<area shape="rect" id="node11" href="a00044.html" title="This abstracts class represents customers." alt="" coords="244,175,367,203"/>
<area shape="rect" id="node15" href="a00051.html" title="Represents the (independent) demand in the system. It can represent a customer order..." alt="" coords="248,283,363,311"/>
<area shape="rect" id="node23" href="a00088.html" title="An item defines the products being planned, sold, stored and/or manufactured. Buffers..." alt="" coords="260,359,351,387"/>
<area shape="rect" id="node27" href="a00108.html" title="This abstract class is used to associate buffers and resources with a physical or..." alt="" coords="248,410,363,438"/>
<area shape="rect" id="node31" href="a00121.html" title="An operation represents an activity: these consume and produce material, take time..." alt="" coords="244,537,367,565"/>
<area shape="rect" id="node43" href="a00156.html" title="This class represents a workcentre, a physical or logical representation of capacity..." alt="" coords="244,714,367,742"/>
<area shape="rect" id="node5" href="a00009.html" title="This class is the default implementation of the abstract Buffer class." alt="" coords="455,5,593,33"/>
<area shape="rect" id="node7" href="a00010.html" title="This class represents a material buffer with an infinite supply of extra material..." alt="" coords="456,55,592,83"/>
<area shape="rect" id="node9" href="a00012.html" title="This class models a buffer that is replenish by an external supplier using a reorder-point..." alt="" coords="452,106,596,134"/>
<area shape="rect" id="node13" href="a00045.html" title="This class implements the abstract Customer class." alt="" coords="443,157,605,185"/>
<area shape="rect" id="node17" href="a00052.html" title="This class is the default implementation of the abstract Demand class." alt="" coords="447,207,601,235"/>
<area shape="rect" id="node19" href="a00072.html" title="This class represents a bucketized demand signal." alt="" coords="436,258,612,286"/>
<area shape="rect" id="node21" href="a00073.html" title="This class represents a forecast value in a time bucket." alt="" coords="416,309,632,337"/>
<area shape="rect" id="node25" href="a00089.html" title="This class is the default implementation of the abstract Item class." alt="" coords="459,359,589,387"/>
<area shape="rect" id="node29" href="a00109.html" title="This class implements the abstract Location class." alt="" coords="447,410,601,438"/>
<area shape="rect" id="node33" href="a00122.html" title="This class represents a choice between multiple operations. The alternates are sorted..." alt="" coords="436,461,612,489"/>
<area shape="rect" id="node35" href="a00123.html" title="Models an operation that takes a fixed amount of time, independent of the quantity..." alt="" coords="432,511,616,539"/>
<area shape="rect" id="node37" href="a00128.html" title="Represents a routing operation, i.e. an operation consisting of multiple, sequential..." alt="" coords="440,562,608,590"/>
<area shape="rect" id="node39" href="a00129.html" title="Models an operation to convert a setup on a resource." alt="" coords="445,613,603,641"/>
<area shape="rect" id="node41" href="a00130.html" title="Models an operation whose duration is the sum of a constant time, plus a cetain time..." alt="" coords="439,663,609,691"/>
<area shape="rect" id="node45" href="a00157.html" title="This class is the default implementation of the abstract Resource class." alt="" coords="443,714,605,742"/>
<area shape="rect" id="node47" href="a00158.html" title="This class represents a resource that'll never have any capacity shortage." alt="" coords="444,765,604,793"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="a00588.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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#ad6c2b65721b36431bcbb8d6e218fde7c">endElement</a> (<a class="el" href="a00186.html">XMLInput</a> &, const <a class="el" href="a00002.html">Attribute</a> &, const <a class="el" href="a00047.html">DataElement</a> &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#af0eb12cffb01b34278b77d1af02d2ddd">getCategory</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#aff438ae1fc6f5899acdc16217bbdd3a8">getDescription</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a3f197282206d815ab8e8cdb0f4b49cc0">getSubCategory</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a765bec78ade5db873ae5d2c1a56238ab">setCategory</a> (const string &f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a86430aaf17c259450986d8ad73aa2fbf">setDescription</a> (const string &f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#abd65cc21a6a0636f3569e90e89e54e5f">setSubCategory</a> (const string &f)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#aff43518d92c1ac8298ce3df9ad4c9fbb">writeElement</a> (<a class="el" href="a00189.html">XMLOutput</a> *, const <a class="el" href="a00096.html">Keyword</a> &, <a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a>=DEFAULT) const </td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00082.html#a3cfae26eb004dfe977271fdedacbb5e3">extrasize</a> () const </td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>This is a decorator class for the main objects. </p>
<p>Instances of this class have a description, category and sub_category. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04780">4780</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad6c2b65721b36431bcbb8d6e218fde7c"></a><!-- doxytag: member="frepple::utils::HasDescription::endElement" ref="ad6c2b65721b36431bcbb8d6e218fde7c" args="(XMLInput &, const Attribute &, const DataElement &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::utils::HasDescription::endElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00186.html">XMLInput</a> & </td>
<td class="paramname"> <em>pIn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00002.html">Attribute</a> & </td>
<td class="paramname"> <em>pAttr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00047.html">DataElement</a> & </td>
<td class="paramname"> <em>pElement</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="a00108.html#a4ed966c56ce9f0d36c2eafdf6d33c9a8">frepple::Location</a>, <a class="el" href="a00044.html#ad1392742a456d7eb2c9ca9e393cbfe5e">frepple::Customer</a>, <a class="el" href="a00121.html#aa201f6f1dd9d0194ac419345333a5a7f">frepple::Operation</a>, <a class="el" href="a00123.html#aa83d7a485466fa68f047cd9bcacb5bf7">frepple::OperationFixedTime</a>, <a class="el" href="a00130.html#a19fb3f3759863a01b23df6566c602495">frepple::OperationTimePer</a>, <a class="el" href="a00128.html#a17ba27923c4f9e18199c48a9e4c7c980">frepple::OperationRouting</a>, <a class="el" href="a00122.html#aa1a730f69090603825c925e332491b4c">frepple::OperationAlternate</a>, <a class="el" href="a00088.html#a86f4b3f7c6e468862ecafaebac75ef1b">frepple::Item</a>, <a class="el" href="a00008.html#a561782e0a5a6fb84c62209aba172a241">frepple::Buffer</a>, <a class="el" href="a00012.html#a50c10dee04e69195b5cccf8d91f9a3e9">frepple::BufferProcure</a>, <a class="el" href="a00156.html#a9c2b68e465e4a45d7e1c0f2125172eb6">frepple::Resource</a>, <a class="el" href="a00051.html#a368aa3430232ac2886706f8c1c448c73">frepple::Demand</a>, and <a class="el" href="a00072.html#a7684ca786326565eb2f7ceed1a821c5d">module_forecast::Forecast</a>.</p>
<p>Definition at line <a class="el" href="a00211_source.html#l00464">464</a> of file <a class="el" href="a00211_source.html">utils/library.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3cfae26eb004dfe977271fdedacbb5e3"></a><!-- doxytag: member="frepple::utils::HasDescription::extrasize" ref="a3cfae26eb004dfe977271fdedacbb5e3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t frepple::utils::HasDescription::extrasize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the memory size in bytes. </p>
<p>Reimplemented in <a class="el" href="a00108.html#a2587326b700889cad3ce7db601943f33">frepple::Location</a>, <a class="el" href="a00044.html#aa79b4a38eb4d82c5b8f4307369bf26d9">frepple::Customer</a>, <a class="el" href="a00121.html#ab5ac84c04cba58284043a4c36bd6621b">frepple::Operation</a>, <a class="el" href="a00008.html#afb235b441282eca100f3747c733914b2">frepple::Buffer</a>, <a class="el" href="a00156.html#a75e809322047e65301729bf48680d14d">frepple::Resource</a>, and <a class="el" href="a00051.html#a07679a31e460ddd841b73b47a8bb13be">frepple::Demand</a>.</p>
<p>Definition at line <a class="el" href="a00252_source.html#l04806">4806</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="af0eb12cffb01b34278b77d1af02d2ddd"></a><!-- doxytag: member="frepple::utils::HasDescription::getCategory" ref="af0eb12cffb01b34278b77d1af02d2ddd" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::utils::HasDescription::getCategory </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the category. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04784">4784</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="aff438ae1fc6f5899acdc16217bbdd3a8"></a><!-- doxytag: member="frepple::utils::HasDescription::getDescription" ref="aff438ae1fc6f5899acdc16217bbdd3a8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::utils::HasDescription::getDescription </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the getDescription. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04790">4790</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a3f197282206d815ab8e8cdb0f4b49cc0"></a><!-- doxytag: member="frepple::utils::HasDescription::getSubCategory" ref="a3f197282206d815ab8e8cdb0f4b49cc0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string frepple::utils::HasDescription::getSubCategory </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the sub_category. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04787">4787</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a765bec78ade5db873ae5d2c1a56238ab"></a><!-- doxytag: member="frepple::utils::HasDescription::setCategory" ref="a765bec78ade5db873ae5d2c1a56238ab" args="(const string &f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::utils::HasDescription::setCategory </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>f</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the category field. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04793">4793</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="a86430aaf17c259450986d8ad73aa2fbf"></a><!-- doxytag: member="frepple::utils::HasDescription::setDescription" ref="a86430aaf17c259450986d8ad73aa2fbf" args="(const string &f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::utils::HasDescription::setDescription </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>f</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the description field. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04799">4799</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="abd65cc21a6a0636f3569e90e89e54e5f"></a><!-- doxytag: member="frepple::utils::HasDescription::setSubCategory" ref="abd65cc21a6a0636f3569e90e89e54e5f" args="(const string &f)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::utils::HasDescription::setSubCategory </td>
<td>(</td>
<td class="paramtype">const string & </td>
<td class="paramname"> <em>f</em></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the sub_category field. </p>
<p>Definition at line <a class="el" href="a00252_source.html#l04796">4796</a> of file <a class="el" href="a00252_source.html">utils.h</a>.</p>
</div>
</div>
<a class="anchor" id="aff43518d92c1ac8298ce3df9ad4c9fbb"></a><!-- doxytag: member="frepple::utils::HasDescription::writeElement" ref="aff43518d92c1ac8298ce3df9ad4c9fbb" args="(XMLOutput *, const Keyword &, mode=DEFAULT) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void frepple::utils::HasDescription::writeElement </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00189.html">XMLOutput</a> * </td>
<td class="paramname"> <em>o</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00096.html">Keyword</a> & </td>
<td class="paramname"> <em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00257.html#a20c2c7e4c6b668e71c154ae3eb18f398">mode</a> </td>
<td class="paramname"> <em>m</em> = <code>DEFAULT</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented in <a class="el" href="a00108.html#a67e5982fe4bf68635fb5ebbaa3bed6df">frepple::Location</a>, <a class="el" href="a00044.html#a965897378d171498bdc39f897857dede">frepple::Customer</a>, <a class="el" href="a00121.html#a3db91252184523fa8246064446d56b60">frepple::Operation</a>, <a class="el" href="a00123.html#aaa6f2f9a016a3af3db4d3703b0ef469f">frepple::OperationFixedTime</a>, <a class="el" href="a00129.html#afcbe8d4db472da78e2f9391078173e6f">frepple::OperationSetup</a>, <a class="el" href="a00130.html#a3b99f67bf66dd84414770ce2ee8617a4">frepple::OperationTimePer</a>, <a class="el" href="a00128.html#a6b681054d10d974688b5a0d92ea4d5f7">frepple::OperationRouting</a>, <a class="el" href="a00122.html#abc8519120ca9ff5e0be1a65131751a09">frepple::OperationAlternate</a>, <a class="el" href="a00088.html#aafc2bddafc95d5a8381d98f76ea2aa45">frepple::Item</a>, <a class="el" href="a00008.html#a8e72becff5b6b068ce2cd9e008902209">frepple::Buffer</a>, <a class="el" href="a00010.html#a49b7c093cc51337c3f9536eca163416f">frepple::BufferInfinite</a>, <a class="el" href="a00012.html#a452abe7405e755e660a5b11a670c4996">frepple::BufferProcure</a>, <a class="el" href="a00156.html#a9b84a7753b5eca34228a34170d4b7174">frepple::Resource</a>, <a class="el" href="a00158.html#a5cde905609c6f34480bb33dfc0cd9add">frepple::ResourceInfinite</a>, <a class="el" href="a00051.html#af36c6828c858ed4bc7c26fa2ddc33c23">frepple::Demand</a>, and <a class="el" href="a00072.html#a0d4e1372b309d8a5d1efbe4e8049621c">module_forecast::Forecast</a>.</p>
<p>Definition at line <a class="el" href="a00211_source.html#l00453">453</a> of file <a class="el" href="a00211_source.html">utils/library.cpp</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="a00211_source.html">utils/library.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>
