aboutsummaryrefslogblamecommitdiffstats
path: root/doc/html/classmeow_1_1factory__types_1_1Base.html
blob: 86c387c8aedb9982daa0961d21d98b08a9631be8 (plain) (tree)

































































































































































































































































































































                                                                                                                                                                                                                                                                                                                                                                                                                                                 
<!-- HTML header for doxygen 1.8.3.1-->
<!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.6"/>
<title>Templates -- Meow: meow::factory_types::Base 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="stylesheet.css" rel="stylesheet" type="text/css" />
<link href="custom.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="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">Templates -- Meow
   &#160;<span id="projectnumber">2.0.-1</span>
   </div>
   <div id="projectbrief">A C++ template contains kinds of interesting classes and functions</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classmeow_1_1factory__types_1_1Base.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="classmeow_1_1factory__types_1_1Base-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">meow::factory_types::Base Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>A base class for kinds of factory classes.  
 <a href="classmeow_1_1factory__types_1_1Base.html#details">More...</a></p>

<p><code>#include &quot;<a class="el" href="factory_8h_source.html">factory.h</a>&quot;</code></p>
<div class="dynheader">
Inheritance diagram for meow::factory_types::Base:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classmeow_1_1factory__types_1_1Base.png" usemap="#meow::factory_types::Base_map" alt=""/>
  <map id="meow::factory_types::Base_map" name="meow::factory_types::Base_map">
<area href="classmeow_1_1factory__types_1_1CheckOff.html" alt="meow::factory_types::CheckOff" shape="rect" coords="0,56,187,80"/>
<area href="classmeow_1_1factory__types_1_1CheckOn.html" alt="meow::factory_types::CheckOn" shape="rect" coords="197,56,384,80"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmeow_1_1factory__types_1_1Base_1_1BaseData.html">BaseData</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a8f38aaec6dcb7f89d220f417ea0c0246"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1factory__types_1_1Base.html#a8f38aaec6dcb7f89d220f417ea0c0246">~Base</a> ()</td></tr>
<tr class="separator:a8f38aaec6dcb7f89d220f417ea0c0246"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace87f7e3d9b5eeceb9b90f4b20a0526c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1State.html">State</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1factory__types_1_1Base.html#ace87f7e3d9b5eeceb9b90f4b20a0526c">Update</a> () const =0</td></tr>
<tr class="memdesc:ace87f7e3d9b5eeceb9b90f4b20a0526c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Updates the output elements by re-run the operation.  <a href="#ace87f7e3d9b5eeceb9b90f4b20a0526c">More...</a><br/></td></tr>
<tr class="separator:ace87f7e3d9b5eeceb9b90f4b20a0526c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7737a2990da8cb6ae2db784165eb2344"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1factory__types_1_1Base.html#a7737a2990da8cb6ae2db784165eb2344">HasRedo</a> () const =0</td></tr>
<tr class="memdesc:a7737a2990da8cb6ae2db784165eb2344"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the last time calling <code><a class="el" href="classmeow_1_1factory__types_1_1Base.html#ace87f7e3d9b5eeceb9b90f4b20a0526c" title="Updates the output elements by re-run the operation. ">Update()</a></code> did update really or not.  <a href="#a7737a2990da8cb6ae2db784165eb2344">More...</a><br/></td></tr>
<tr class="separator:a7737a2990da8cb6ae2db784165eb2344"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad66fb923b34020efe11b679947729f65"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1Pointer.html">Pointer</a>&lt; <a class="el" href="classmeow_1_1Operation.html">Operation</a> const  &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1factory__types_1_1Base.html#ad66fb923b34020efe11b679947729f65">operation</a> () const =0</td></tr>
<tr class="memdesc:ad66fb923b34020efe11b679947729f65"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the operation.  <a href="#ad66fb923b34020efe11b679947729f65">More...</a><br/></td></tr>
<tr class="separator:ad66fb923b34020efe11b679947729f65"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acdaf437535980cda9b755957f603ca04"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1Pointer.html">Pointer</a>&lt; <a class="el" href="classmeow_1_1Pointer.html">Pointer</a><br class="typebreak"/>
&lt; <a class="el" href="classmeow_1_1Object.html">Object</a> &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1factory__types_1_1Base.html#acdaf437535980cda9b755957f603ca04">inputs</a> () const =0</td></tr>
<tr class="memdesc:acdaf437535980cda9b755957f603ca04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the pointer points to the array of input elements.  <a href="#acdaf437535980cda9b755957f603ca04">More...</a><br/></td></tr>
<tr class="separator:acdaf437535980cda9b755957f603ca04"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4a10214f687f4bcb93b6cceaa8457640"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1Pointer.html">Pointer</a>&lt; <a class="el" href="classmeow_1_1Pointer.html">Pointer</a><br class="typebreak"/>
&lt; <a class="el" href="classmeow_1_1Object.html">Object</a> const  &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1factory__types_1_1Base.html#a4a10214f687f4bcb93b6cceaa8457640">outputs</a> () const =0</td></tr>
<tr class="memdesc:a4a10214f687f4bcb93b6cceaa8457640"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the pointer points to the array of output elements.  <a href="#a4a10214f687f4bcb93b6cceaa8457640">More...</a><br/></td></tr>
<tr class="separator:a4a10214f687f4bcb93b6cceaa8457640"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:af9d31c1d233acb87d994254428bc0e10"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1factory__types_1_1Base.html#af9d31c1d233acb87d994254428bc0e10">Base</a> ()</td></tr>
<tr class="separator:af9d31c1d233acb87d994254428bc0e10"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A base class for kinds of factory classes. </p>

<p>Definition at line <a class="el" href="factory_8h_source.html#l00029">29</a> of file <a class="el" href="factory_8h_source.html">factory.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="af9d31c1d233acb87d994254428bc0e10"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">meow::factory_types::Base::Base </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="factory_8h_source.html#l00072">72</a> of file <a class="el" href="factory_8h_source.html">factory.h</a>.</p>

</div>
</div>
<a class="anchor" id="a8f38aaec6dcb7f89d220f417ea0c0246"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual meow::factory_types::Base::~Base </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Definition at line <a class="el" href="factory_8h_source.html#l00075">75</a> of file <a class="el" href="factory_8h_source.html">factory.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a7737a2990da8cb6ae2db784165eb2344"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool meow::factory_types::Base::HasRedo </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Returns whether the last time calling <code><a class="el" href="classmeow_1_1factory__types_1_1Base.html#ace87f7e3d9b5eeceb9b90f4b20a0526c" title="Updates the output elements by re-run the operation. ">Update()</a></code> did update really or not. </p>
<p>If the input elements were not changed before <code><a class="el" href="classmeow_1_1factory__types_1_1Base.html#ace87f7e3d9b5eeceb9b90f4b20a0526c" title="Updates the output elements by re-run the operation. ">Update()</a></code> be called, it might be returns false (depends on how it implements). </p>

<p>Implemented in <a class="el" href="classmeow_1_1factory__types_1_1CheckOn.html#ab9a2f0c2d314af779925a668160798a2">meow::factory_types::CheckOn</a>, and <a class="el" href="classmeow_1_1factory__types_1_1CheckOff.html#aa03a97727cb02dc5704bbee42fba15c4">meow::factory_types::CheckOff</a>.</p>

</div>
</div>
<a class="anchor" id="acdaf437535980cda9b755957f603ca04"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classmeow_1_1Pointer.html">Pointer</a>&lt;<a class="el" href="classmeow_1_1Pointer.html">Pointer</a>&lt;<a class="el" href="classmeow_1_1Object.html">Object</a>&gt; &gt; meow::factory_types::Base::inputs </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the pointer points to the array of input elements. </p>

<p>Implemented in <a class="el" href="classmeow_1_1factory__types_1_1CheckOn.html#af70923860eadbbe19a143d6b572e3067">meow::factory_types::CheckOn</a>, and <a class="el" href="classmeow_1_1factory__types_1_1CheckOff.html#ad1da2455b8b244fbf56c26ceb5aa2cd6">meow::factory_types::CheckOff</a>.</p>

</div>
</div>
<a class="anchor" id="ad66fb923b34020efe11b679947729f65"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classmeow_1_1Pointer.html">Pointer</a>&lt;<a class="el" href="classmeow_1_1Operation.html">Operation</a> const&gt; meow::factory_types::Base::operation </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the operation. </p>

<p>Implemented in <a class="el" href="classmeow_1_1factory__types_1_1CheckOn.html#a56643797e0c74735196a5ee8632cd8a7">meow::factory_types::CheckOn</a>, and <a class="el" href="classmeow_1_1factory__types_1_1CheckOff.html#ac257f0470a0dd5019a6d0277486b80bb">meow::factory_types::CheckOff</a>.</p>

</div>
</div>
<a class="anchor" id="a4a10214f687f4bcb93b6cceaa8457640"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classmeow_1_1Pointer.html">Pointer</a>&lt;<a class="el" href="classmeow_1_1Pointer.html">Pointer</a>&lt;<a class="el" href="classmeow_1_1Object.html">Object</a> const&gt; &gt; meow::factory_types::Base::outputs </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets the pointer points to the array of output elements. </p>

<p>Implemented in <a class="el" href="classmeow_1_1factory__types_1_1CheckOn.html#af89f44b53a6596887b9f5cafb42df7e2">meow::factory_types::CheckOn</a>, and <a class="el" href="classmeow_1_1factory__types_1_1CheckOff.html#a9f58bf91c9b3da9a791a8027ed0a6c78">meow::factory_types::CheckOff</a>.</p>

</div>
</div>
<a class="anchor" id="ace87f7e3d9b5eeceb9b90f4b20a0526c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classmeow_1_1State.html">State</a> meow::factory_types::Base::Update </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Updates the output elements by re-run the operation. </p>

<p>Implemented in <a class="el" href="classmeow_1_1factory__types_1_1CheckOn.html#a90040b2f052f5aa2cb6dccbaa5f4b8c2">meow::factory_types::CheckOn</a>, and <a class="el" href="classmeow_1_1factory__types_1_1CheckOff.html#a161f8e8b9a71c4b9a700a04a845dd571">meow::factory_types::CheckOff</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/cathook/Projects/template_meow/meowpp/utility/<a class="el" href="factory_8h_source.html">factory.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.3.1-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="namespacemeow.html">meow</a></li><li class="navelem"><a class="el" href="namespacemeow_1_1factory__types.html">factory_types</a></li><li class="navelem"><a class="el" href="classmeow_1_1factory__types_1_1Base.html">Base</a></li>
    <li class="footer">Generated on Mon Sep 29 2014 16:55:35 for Templates -- Meow by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>