diff mayachemtools/docs/modules/html/code/ObjectProperty.html @ 0:73ae111cf86f draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mayachemtools/docs/modules/html/code/ObjectProperty.html	Wed Jan 20 11:55:01 2016 -0500
@@ -0,0 +1,178 @@
+<html>
+<head>
+<title>MayaChemTools:Code:ObjectProperty.pm</title>
+<meta http-equiv="content-type" content="text/html;charset=utf-8">
+<link rel="stylesheet" type="text/css" href="../../../css/MayaChemToolsCode.css">
+</head>
+<body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
+<br/>
+<center>
+<a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
+</center>
+<br/>
+<pre>
+<a name="package-ObjectProperty-"></a>   1 <span class="k">package </span><span class="i">ObjectProperty</span><span class="sc">;</span>
+   2 <span class="c">#</span>
+   3 <span class="c"># $RCSfile: ObjectProperty.pm,v $</span>
+   4 <span class="c"># $Date: 2015/02/28 20:47:18 $</span>
+   5 <span class="c"># $Revision: 1.25 $</span>
+   6 <span class="c">#</span>
+   7 <span class="c"># Author: Manish Sud &lt;msud@san.rr.com&gt;</span>
+   8 <span class="c">#</span>
+   9 <span class="c"># Copyright (C) 2015 Manish Sud. All rights reserved.</span>
+  10 <span class="c">#</span>
+  11 <span class="c"># This file is part of MayaChemTools.</span>
+  12 <span class="c">#</span>
+  13 <span class="c"># MayaChemTools is free software; you can redistribute it and/or modify it under</span>
+  14 <span class="c"># the terms of the GNU Lesser General Public License as published by the Free</span>
+  15 <span class="c"># Software Foundation; either version 3 of the License, or (at your option) any</span>
+  16 <span class="c"># later version.</span>
+  17 <span class="c">#</span>
+  18 <span class="c"># MayaChemTools is distributed in the hope that it will be useful, but without</span>
+  19 <span class="c"># any warranty; without even the implied warranty of merchantability of fitness</span>
+  20 <span class="c"># for a particular purpose.  See the GNU Lesser General Public License for more</span>
+  21 <span class="c"># details.</span>
+  22 <span class="c">#</span>
+  23 <span class="c"># You should have received a copy of the GNU Lesser General Public License</span>
+  24 <span class="c"># along with MayaChemTools; if not, see &lt;http://www.gnu.org/licenses/&gt; or</span>
+  25 <span class="c"># write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,</span>
+  26 <span class="c"># Boston, MA, 02111-1307, USA.</span>
+  27 <span class="c">#</span>
+  28 
+  29 <span class="k">use</span> <span class="w">strict</span><span class="sc">;</span>
+  30 <span class="k">use</span> <span class="w">Carp</span><span class="sc">;</span>
+  31 
+  32 <span class="k">use</span> <span class="w">vars</span> <span class="q">qw($AUTOLOAD)</span><span class="sc">;</span>
+  33 
+  34 <span class="c"># Set property for an object...</span>
+<a name="SetProperty-"></a>  35 <span class="k">sub </span><span class="m">SetProperty</span> <span class="s">{</span>
+  36   <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  37 
+  38   <span class="k">if</span> <span class="s">(</span>!<span class="s">(</span><span class="k">defined</span><span class="s">(</span><span class="i">$Name</span><span class="s">)</span> &amp;&amp; <span class="k">defined</span><span class="s">(</span><span class="i">$Value</span><span class="s">)</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span>
+  39     <span class="k">return</span> <span class="k">undef</span><span class="sc">;</span>
+  40   <span class="s">}</span>
+  41   <span class="k">return</span> <span class="i">$This</span><span class="i">-&gt;_SetProperty</span><span class="s">(</span><span class="i">$Name</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
+  42 <span class="s">}</span>
+  43 
+  44 <span class="c"># Set properties for an object...</span>
+<a name="SetProperties-"></a>  45 <span class="k">sub </span><span class="m">SetProperties</span> <span class="s">{</span>
+  46   <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">%NamesAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  47   <span class="k">my</span><span class="s">(</span><span class="i">$Name</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
+  48 
+  49   <span class="k">while</span> <span class="s">(</span><span class="s">(</span><span class="i">$Name</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="k">each</span>  <span class="i">%NamesAndValues</span><span class="s">)</span> <span class="s">{</span>
+  50     <span class="i">$This</span><span class="i">-&gt;_SetProperty</span><span class="s">(</span><span class="i">$Name</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span><span class="sc">;</span>
+  51   <span class="s">}</span>
+  52 
+  53   <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
+  54 <span class="s">}</span>
+  55 
+  56 <span class="c"># Set object property...</span>
+<a name="_SetProperty-"></a>  57 <span class="k">sub </span><span class="m">_SetProperty</span> <span class="s">{</span>
+  58   <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  59 
+  60   <span class="i">$This</span>-&gt;{<span class="i">$Name</span>} = <span class="i">$Value</span><span class="sc">;</span>
+  61 <span class="s">}</span>
+  62 
+  63 <span class="c"># Get property for an object...</span>
+<a name="GetProperty-"></a>  64 <span class="k">sub </span><span class="m">GetProperty</span> <span class="s">{</span>
+  65   <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  66 
+  67   <span class="k">if</span> <span class="s">(</span>!<span class="k">defined</span> <span class="i">$Name</span><span class="s">)</span> <span class="s">{</span>
+  68     <span class="k">return</span> <span class="k">undef</span><span class="sc">;</span>
+  69   <span class="s">}</span>
+  70   <span class="k">return</span> <span class="i">$This</span><span class="i">-&gt;_GetProperty</span><span class="s">(</span><span class="i">$Name</span><span class="s">)</span><span class="sc">;</span>
+  71 <span class="s">}</span>
+  72 
+  73 <span class="c"># Get object property...</span>
+<a name="_GetProperty-"></a>  74 <span class="k">sub </span><span class="m">_GetProperty</span> <span class="s">{</span>
+  75   <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  76 
+  77   <span class="k">if</span> <span class="s">(</span><span class="k">exists</span> <span class="i">$This</span>-&gt;{<span class="i">$Name</span>}<span class="s">)</span> <span class="s">{</span>
+  78     <span class="k">return</span> <span class="i">$This</span>-&gt;{<span class="i">$Name</span>}<span class="sc">;</span>
+  79   <span class="s">}</span>
+  80   <span class="k">else</span> <span class="s">{</span>
+  81     <span class="k">return</span> <span class="k">undef</span><span class="sc">;</span>
+  82   <span class="s">}</span>
+  83 <span class="s">}</span>
+  84 
+  85 <span class="c"># Does this property exist?</span>
+<a name="HasProperty-"></a>  86 <span class="k">sub </span><span class="m">HasProperty</span> <span class="s">{</span>
+  87   <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  88 
+  89   <span class="k">if</span> <span class="s">(</span>!<span class="k">defined</span> <span class="i">$Name</span><span class="s">)</span> <span class="s">{</span>
+  90     <span class="k">return</span> <span class="n">0</span><span class="sc">;</span>
+  91   <span class="s">}</span>
+  92   <span class="k">return</span> <span class="s">(</span><span class="k">exists</span> <span class="i">$This</span>-&gt;{<span class="i">$Name</span>}<span class="s">)</span> ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span>
+  93 <span class="s">}</span>
+  94 
+  95 <span class="c"># Delete object property...</span>
+<a name="DeleteProperty-"></a>  96 <span class="k">sub </span><span class="m">DeleteProperty</span> <span class="s">{</span>
+  97   <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+  98 
+  99   <span class="k">if</span> <span class="s">(</span>!<span class="k">defined</span> <span class="i">$Name</span><span class="s">)</span> <span class="s">{</span>
+ 100     <span class="k">return</span> <span class="k">undef</span><span class="sc">;</span>
+ 101   <span class="s">}</span>
+ 102   <span class="k">return</span> <span class="i">$This</span><span class="i">-&gt;_DeleteProperty</span><span class="s">(</span><span class="i">$Name</span><span class="s">)</span><span class="sc">;</span>
+ 103 <span class="s">}</span>
+ 104 
+ 105 <span class="c"># Delete object property...</span>
+<a name="_DeleteProperty-"></a> 106 <span class="k">sub </span><span class="m">_DeleteProperty</span> <span class="s">{</span>
+ 107   <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+ 108 
+ 109   <span class="k">if</span> <span class="s">(</span><span class="k">exists</span> <span class="i">$This</span>-&gt;{<span class="i">$Name</span>}<span class="s">)</span> <span class="s">{</span>
+ 110     <span class="k">delete</span> <span class="i">$This</span>-&gt;{<span class="i">$Name</span>}<span class="sc">;</span>
+ 111   <span class="s">}</span>
+ 112   <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
+ 113 <span class="s">}</span>
+ 114 
+ 115 <span class="c"># Implements Set&lt;PropertyName&gt; and Get&lt;PropertyName&gt; methods...</span>
+<a name="AUTOLOAD-"></a> 116 <span class="k">sub </span><span class="m">AUTOLOAD</span> <span class="s">{</span>
+ 117   <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$PropertyValue</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
+ 118   <span class="k">my</span><span class="s">(</span><span class="i">$PackageName</span><span class="cm">,</span> <span class="i">$MethodName</span><span class="cm">,</span> <span class="i">$PropertyName</span><span class="cm">,</span> <span class="i">$ThisType</span><span class="s">)</span><span class="sc">;</span>
+ 119 
+ 120   <span class="c"># Do a greedy match to make sure package name and method names are</span>
+ 121   <span class="c"># picked up correctly from invocation names containing multiple occurences</span>
+ 122   <span class="c"># of ::. For example: FileIO::SDFileIO::GetFileHandle and so on.</span>
+ 123   <span class="c">#</span>
+ 124   <span class="s">(</span><span class="i">$PackageName</span><span class="cm">,</span> <span class="i">$MethodName</span><span class="s">)</span> = <span class="i">$AUTOLOAD</span> =~ <span class="q">/^(.*)::(.*)$/</span><span class="sc">;</span>
+ 125 
+ 126   <span class="k">if</span> <span class="s">(</span><span class="i">$MethodName</span> =~ <span class="q">/^(BEGIN|DESTROY)$/</span><span class="s">)</span> <span class="s">{</span>
+ 127     <span class="k">return</span><span class="sc">;</span>
+ 128   <span class="s">}</span>
+ 129 
+ 130   <span class="i">$ThisType</span> = <span class="k">ref</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> <span class="k">or</span> <span class="w">croak</span> <span class="q">&quot;Error: Invocation of function ${PackageName}::${MethodName} invocation is not supported: It must be invoked using an object reference...&quot;</span><span class="sc">;</span>
+ 131 
+ 132   <span class="k">if</span> <span class="s">(</span>!<span class="s">(</span><span class="i">$MethodName</span> =~ <span class="q">/^Get/</span> || <span class="i">$MethodName</span> =~ <span class="q">/^Set/</span> || <span class="i">$MethodName</span> =~ <span class="q">/^Delete/</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span>
+ 133     <span class="w">croak</span> <span class="q">&quot;Error: Can&#39;t locate object method \&quot;$MethodName\&quot; via package \&quot;$ThisType\&quot;: This method is not automatically implemented by AUTOLOAD: Only Get&lt;PropertyName&gt;, Set&lt;PropertyName&gt; and Delete&lt;PropertyName&gt; functions are implemented via AUTOLOAD...&quot;</span><span class="sc">;</span>
+ 134   <span class="s">}</span>
+ 135   <span class="k">if</span> <span class="s">(</span><span class="i">$MethodName</span> =~ <span class="q">/^Delete/</span><span class="s">)</span> <span class="s">{</span>
+ 136     <span class="s">(</span><span class="i">$PropertyName</span><span class="s">)</span> = <span class="i">$MethodName</span> =~ <span class="q">/^Delete(.*?)$/</span><span class="sc">;</span>
+ 137   <span class="s">}</span>
+ 138   <span class="k">else</span> <span class="s">{</span>
+ 139     <span class="s">(</span><span class="i">$PropertyName</span><span class="s">)</span> = <span class="i">$MethodName</span> =~ <span class="q">/^[SG]et(.*?)$/</span><span class="sc">;</span>
+ 140   <span class="s">}</span>
+ 141   <span class="k">if</span> <span class="s">(</span><span class="i">$MethodName</span> =~ <span class="q">/^Set/</span> &amp;&amp; !<span class="k">defined</span><span class="s">(</span><span class="i">$PropertyValue</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span>
+ 142     <span class="w">carp</span> <span class="q">&quot;Warning:  ${PackageName}::${MethodName}: Didn&#39;t set value for property $PropertyName: Property value for must be specified...\n&quot;</span><span class="sc">;</span>
+ 143     <span class="k">return</span> <span class="k">undef</span><span class="sc">;</span>
+ 144   <span class="s">}</span>
+ 145 
+ 146   <span class="k">if</span> <span class="s">(</span><span class="i">$MethodName</span> =~ <span class="q">/^Get/</span><span class="s">)</span> <span class="s">{</span>
+ 147     <span class="k">return</span> <span class="i">$This</span><span class="i">-&gt;_GetProperty</span><span class="s">(</span><span class="i">$PropertyName</span><span class="s">)</span><span class="sc">;</span>
+ 148   <span class="s">}</span>
+ 149   <span class="k">elsif</span> <span class="s">(</span><span class="i">$MethodName</span> =~ <span class="q">/^Set/</span><span class="s">)</span> <span class="s">{</span>
+ 150     <span class="k">return</span> <span class="i">$This</span><span class="i">-&gt;_SetProperty</span><span class="s">(</span><span class="i">$PropertyName</span><span class="cm">,</span> <span class="i">$PropertyValue</span><span class="s">)</span><span class="sc">;</span>
+ 151   <span class="s">}</span>
+ 152   <span class="k">elsif</span> <span class="s">(</span><span class="i">$MethodName</span> =~ <span class="q">/^Delete/</span><span class="s">)</span> <span class="s">{</span>
+ 153     <span class="k">return</span> <span class="i">$This</span><span class="i">-&gt;_DeleteProperty</span><span class="s">(</span><span class="i">$PropertyName</span><span class="s">)</span><span class="sc">;</span>
+ 154   <span class="s">}</span>
+ 155 
+ 156 <span class="s">}</span>
+ 157 
+<a name="EOF-"></a></pre>
+<p>&nbsp;</p>
+<br />
+<center>
+<img src="../../../images/h2o2.png">
+</center>
+</body>
+</html>