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

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 <html>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 <head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 <title>MayaChemTools:Documentation:ObjectProperty.pm</title>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 </head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 <div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./NucleicAcids.html" title="NucleicAcids.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./PackageInfo.html" title="PackageInfo.html">Next</a></td><td width="34%" align="middle"><strong>ObjectProperty.pm</strong></td><td width="33%" align="right"><a href="././code/ObjectProperty.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/ObjectProperty.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/ObjectProperty.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/ObjectProperty.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/ObjectProperty.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 <h2>NAME</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 <p>ObjectProperty</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 <h2>SYNOPSIS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 <p>use ObjectProperty;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 <h2>DESCRIPTION</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 <p><strong>ObjectProperty</strong> is an abstract base class which implements methods not explicitly defined
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 in classed derived from this class using Perl's AUTOLOAD functionality. These methods are generated
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 on-the-fly for a specified object property:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 Set&lt;PropertyName&gt;(&lt;PropertyValue&gt;);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 <br/> $PropertyValue = Get&lt;PropertyName&gt;();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 <br/> Delete&lt;PropertyName&gt;();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 <p>This class uses its parent class hash to set, get, and delete propery names and values.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 <p>ObjectProperty module provides the following methods to be used in context of its parent class:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 <p> <a href="#deleteproperty">DeleteProperty</a>, <a href="#getproperty">GetProperty</a>, <a href="#hasproperty">HasProperty</a>, <a href="#setproperties">SetProperties</a>, <a href="#setproperty">SetProperty</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 </p><p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 <h2>METHODS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 <dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 <dt><strong><a name="deleteproperty" class="item"><strong>DeleteProperty</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 DeleteProperty($Name);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 <p>Deletes specified property <em>Name</em></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 <dt><strong><a name="getproperty" class="item"><strong>GetProperty</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 GetProperty($Name);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 <p>Returns value associated with specified property <em>Name</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 <dt><strong><a name="hasproperty" class="item"><strong>HasProperty</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 HasProperty($Name);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 <p>Returns 1 or 0 based on whether specified property <em>Name</em> associated with an object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 <dt><strong><a name="setproperties" class="item"><strong>SetProperties</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 SetProperties(%NamesAndValues);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 <p>Using specified property name and value hash <em>NamesAndValues</em>, associates each
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 property <em>Name</em> and <em>Values</em> to an object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 <dt><strong><a name="setproperty" class="item"><strong>SetProperty</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 SetProperty($Name, $Value);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 <p>Associate property <em>Name</em> and <em>Value</em> to an object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 </dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 <h2>AUTHOR</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 <h2>COPYRIGHT</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 <p>This file is part of MayaChemTools.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 any later version.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 <tr align="left" valign="top"><td width="33%" align="left"><a href="./NucleicAcids.html" title="NucleicAcids.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./PackageInfo.html" title="PackageInfo.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>ObjectProperty.pm</strong></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 <img src="../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 </html>