diff options
Diffstat (limited to 'doc/html/classmeow_1_1Object.html')
| -rw-r--r-- | doc/html/classmeow_1_1Object.html | 337 |
1 files changed, 337 insertions, 0 deletions
diff --git a/doc/html/classmeow_1_1Object.html b/doc/html/classmeow_1_1Object.html new file mode 100644 index 0000000..a1a194b --- /dev/null +++ b/doc/html/classmeow_1_1Object.html @@ -0,0 +1,337 @@ +<!-- 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::Object 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 +  <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_1Object.html','');}); +</script> +<div id="doc-content"> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pro-methods">Protected Member Functions</a> | +<a href="classmeow_1_1Object-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">meow::Object Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>The base class. + <a href="classmeow_1_1Object.html#details">More...</a></p> + +<p><code>#include "<a class="el" href="object_8h_source.html">object.h</a>"</code></p> +<div class="dynheader"> +Inheritance diagram for meow::Object:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classmeow_1_1Object.png" usemap="#meow::Object_map" alt=""/> + <map id="meow::Object_map" name="meow::Object_map"> +<area href="classmeow_1_1BaseFloatingType.html" title="A class for floating-point base object. " alt="meow::BaseFloatingType< DataType >" shape="rect" coords="341,56,672,80"/> +<area href="classmeow_1_1BaseNumberType.html" title="A class for number base object. " alt="meow::BaseNumberType< DataType >" shape="rect" coords="341,112,672,136"/> +<area href="classmeow_1_1Factory.html" title="A class which contains input elements, output elements and an operation. " alt="meow::Factory" shape="rect" coords="341,168,672,192"/> +<area href="classmeow_1_1Operation.html" title="Base class for operations. " alt="meow::Operation" shape="rect" coords="341,224,672,248"/> +<area href="classmeow_1_1Pointer.html" title="A pointer points to the template Type. " alt="meow::Pointer< Type >" shape="rect" coords="341,280,672,304"/> +<area href="classmeow_1_1State.html" title="The base class for state. " alt="meow::State" shape="rect" coords="341,336,672,360"/> +<area href="classmeow_1_1Pointer.html" alt="meow::Pointer< factory_types::Base >" shape="rect" coords="341,392,672,416"/> +<area href="classmeow_1_1Pointer.html" alt="meow::Pointer< meow::Operation const >" shape="rect" coords="341,448,672,472"/> +<area href="classmeow_1_1Pointer.html" alt="meow::Pointer< meow::Pointer< meow::Object > >" shape="rect" coords="341,504,672,528"/> +<area href="classmeow_1_1Pointer.html" alt="meow::Pointer< meow::Pointer< meow::Object const > >" shape="rect" coords="341,560,672,584"/> +</map> + </div></div> +<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:a5e41ab604d3e387c4293863eace18a75"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a5e41ab604d3e387c4293863eace18a75">~Object</a> ()</td></tr> +<tr class="memdesc:a5e41ab604d3e387c4293863eace18a75"><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#a5e41ab604d3e387c4293863eace18a75">More...</a><br/></td></tr> +<tr class="separator:a5e41ab604d3e387c4293863eace18a75"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a875c9a989fc858fd49dd00a0d059142c"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1Object.html">Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a875c9a989fc858fd49dd00a0d059142c">Copy</a> () const </td></tr> +<tr class="memdesc:a875c9a989fc858fd49dd00a0d059142c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a copy of itself and return the pointer to it. <a href="#a875c9a989fc858fd49dd00a0d059142c">More...</a><br/></td></tr> +<tr class="separator:a875c9a989fc858fd49dd00a0d059142c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9b30b1200154d5f71f99694d835b9a49"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classmeow_1_1Object.html">Object</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a9b30b1200154d5f71f99694d835b9a49">CopyFrom</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const *ptr)</td></tr> +<tr class="memdesc:a9b30b1200154d5f71f99694d835b9a49"><td class="mdescLeft"> </td><td class="mdescRight">Copies data from another object. <a href="#a9b30b1200154d5f71f99694d835b9a49">More...</a><br/></td></tr> +<tr class="separator:a9b30b1200154d5f71f99694d835b9a49"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a59485e5cace45c0711fe86b6b693c10f"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a59485e5cace45c0711fe86b6b693c10f">Equals</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const *ptr) const </td></tr> +<tr class="memdesc:a59485e5cace45c0711fe86b6b693c10f"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether it equals to another object or not. <a href="#a59485e5cace45c0711fe86b6b693c10f">More...</a><br/></td></tr> +<tr class="separator:a59485e5cace45c0711fe86b6b693c10f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a9d22bc97e9a5f11acaade41a1f07bc3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classmeow_1_1Object.html">Object</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a9d22bc97e9a5f11acaade41a1f07bc3b">operator=</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const &b)</td></tr> +<tr class="memdesc:a9d22bc97e9a5f11acaade41a1f07bc3b"><td class="mdescLeft"> </td><td class="mdescRight">Disable the copy operator. <a href="#a9d22bc97e9a5f11acaade41a1f07bc3b">More...</a><br/></td></tr> +<tr class="separator:a9d22bc97e9a5f11acaade41a1f07bc3b"><td class="memSeparator" colspan="2"> </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:a8f2e9eec4d103846693a9d0c2b215d23"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a8f2e9eec4d103846693a9d0c2b215d23">Object</a> ()</td></tr> +<tr class="memdesc:a8f2e9eec4d103846693a9d0c2b215d23"><td class="mdescLeft"> </td><td class="mdescRight">A protected constructor to prevent developers create an instance of <a class="el" href="classmeow_1_1Object.html" title="The base class. ">Object</a> directly. <a href="#a8f2e9eec4d103846693a9d0c2b215d23">More...</a><br/></td></tr> +<tr class="separator:a8f2e9eec4d103846693a9d0c2b215d23"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a02b219848bde794cd138aa644c9e6147"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmeow_1_1Object.html#a02b219848bde794cd138aa644c9e6147">Object</a> (<a class="el" href="classmeow_1_1Object.html">Object</a> const &b)</td></tr> +<tr class="memdesc:a02b219848bde794cd138aa644c9e6147"><td class="mdescLeft"> </td><td class="mdescRight">Disable the copy operation. <a href="#a02b219848bde794cd138aa644c9e6147">More...</a><br/></td></tr> +<tr class="separator:a02b219848bde794cd138aa644c9e6147"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>The base class. </p> + +<p>Definition at line <a class="el" href="object_8h_source.html#l00020">20</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a8f2e9eec4d103846693a9d0c2b215d23"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">meow::Object::Object </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>A protected constructor to prevent developers create an instance of <a class="el" href="classmeow_1_1Object.html" title="The base class. ">Object</a> directly. </p> + +<p>Definition at line <a class="el" href="object_8h_source.html#l00027">27</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a02b219848bde794cd138aa644c9e6147"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">meow::Object::Object </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classmeow_1_1Object.html">Object</a> const & </td> + <td class="paramname"><em>b</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">protected</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Disable the copy operation. </p> + +</div> +</div> +<a class="anchor" id="a5e41ab604d3e387c4293863eace18a75"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">virtual meow::Object::~Object </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>Virtual destructor. </p> + +<p>Definition at line <a class="el" href="object_8h_source.html#l00039">39</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="a875c9a989fc858fd49dd00a0d059142c"></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_1Object.html">Object</a>* meow::Object::Copy </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">inline</span><span class="mlabel">virtual</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Creates a copy of itself and return the pointer to it. </p> + +<p>Reimplemented in <a class="el" href="classmeow_1_1Factory.html#aea5b7738bd866c48329dda7b37bec8ca">meow::Factory</a>, <a class="el" href="classmeow_1_1Pointer.html#a7dcbac9a7567b5f2bc3649c968f356cb">meow::Pointer< Type ></a>, <a class="el" href="classmeow_1_1Pointer.html#a7dcbac9a7567b5f2bc3649c968f356cb">meow::Pointer< meow::Pointer< meow::Object > ></a>, <a class="el" href="classmeow_1_1Pointer.html#a7dcbac9a7567b5f2bc3649c968f356cb">meow::Pointer< factory_types::Base ></a>, <a class="el" href="classmeow_1_1Pointer.html#a7dcbac9a7567b5f2bc3649c968f356cb">meow::Pointer< meow::Operation const ></a>, <a class="el" href="classmeow_1_1Pointer.html#a7dcbac9a7567b5f2bc3649c968f356cb">meow::Pointer< meow::Pointer< meow::Object const > ></a>, <a class="el" href="classmeow_1_1BaseFloatingType.html#ae744b5726bd87c70ef981af93c927d0d">meow::BaseFloatingType< DataType ></a>, <a class="el" href="classmeow_1_1State.html#ac31d0101da886027a43968ecca272747">meow::State</a>, and <a class="el" href="classmeow_1_1BaseNumberType.html#a836908847bd64427c8b60b1c266ea749">meow::BaseNumberType< DataType ></a>.</p> + +<p>Definition at line <a class="el" href="object_8h_source.html#l00044">44</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a9b30b1200154d5f71f99694d835b9a49"></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_1Object.html">Object</a>* meow::Object::CopyFrom </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classmeow_1_1Object.html">Object</a> const * </td> + <td class="paramname"><em>ptr</em></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>Copies data from another object. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>Points to another object. </td></tr> + </table> + </dd> +</dl> + +<p>Reimplemented in <a class="el" href="classmeow_1_1Factory.html#a7ad8614449b10fa2ae52289352210a06">meow::Factory</a>, <a class="el" href="classmeow_1_1Pointer.html#a1d438accda78cb6d04fb4ced8f9a8f87">meow::Pointer< Type ></a>, <a class="el" href="classmeow_1_1Pointer.html#a1d438accda78cb6d04fb4ced8f9a8f87">meow::Pointer< meow::Pointer< meow::Object > ></a>, <a class="el" href="classmeow_1_1Pointer.html#a1d438accda78cb6d04fb4ced8f9a8f87">meow::Pointer< factory_types::Base ></a>, <a class="el" href="classmeow_1_1Pointer.html#a1d438accda78cb6d04fb4ced8f9a8f87">meow::Pointer< meow::Operation const ></a>, <a class="el" href="classmeow_1_1Pointer.html#a1d438accda78cb6d04fb4ced8f9a8f87">meow::Pointer< meow::Pointer< meow::Object const > ></a>, <a class="el" href="classmeow_1_1BaseFloatingType.html#a2ce80015f5644d924c0f4eb291fd04ca">meow::BaseFloatingType< DataType ></a>, <a class="el" href="classmeow_1_1State.html#a76f3ca5e2f687b17af9b9adcb0311747">meow::State</a>, and <a class="el" href="classmeow_1_1BaseNumberType.html#ae67c3b0fa23e76a85d7800095d98469b">meow::BaseNumberType< DataType ></a>.</p> + +<p>Definition at line <a class="el" href="object_8h_source.html#l00052">52</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a59485e5cace45c0711fe86b6b693c10f"></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::Object::Equals </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classmeow_1_1Object.html">Object</a> const * </td> + <td class="paramname"><em>ptr</em></td><td>)</td> + <td> const</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>Returns whether it equals to another object or not. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">ptr</td><td>Points to another object. </td></tr> + </table> + </dd> +</dl> + +<p>Reimplemented in <a class="el" href="classmeow_1_1BaseFloatingType.html#ada33b40693aea5403954a45549e6717c">meow::BaseFloatingType< DataType ></a>, and <a class="el" href="classmeow_1_1BaseNumberType.html#a2938f9af8ab0681498c168de94f26951">meow::BaseNumberType< DataType ></a>.</p> + +<p>Definition at line <a class="el" href="object_8h_source.html#l00060">60</a> of file <a class="el" href="object_8h_source.html">object.h</a>.</p> + +</div> +</div> +<a class="anchor" id="a9d22bc97e9a5f11acaade41a1f07bc3b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classmeow_1_1Object.html">Object</a>& meow::Object::operator= </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classmeow_1_1Object.html">Object</a> const & </td> + <td class="paramname"><em>b</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Disable the copy operator. </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="object_8h_source.html">object.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="classmeow_1_1Object.html">Object</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> |