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