Mercurial > repos > deepakjadmin > mayatool3_test3
comparison mayachemtools/docs/modules/html/PackageInfo.html @ 0:73ae111cf86f draft
Uploaded
| author | deepakjadmin |
|---|---|
| date | Wed, 20 Jan 2016 11:55:01 -0500 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:73ae111cf86f |
|---|---|
| 1 <html> | |
| 2 <head> | |
| 3 <title>MayaChemTools:Documentation:PackageInfo.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="./ObjectProperty.html" title="ObjectProperty.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./Lexer.html" title="Lexer.html">Next</a></td><td width="34%" align="middle"><strong>PackageInfo.pm</strong></td><td width="33%" align="right"><a href="././code/PackageInfo.html" title="View source code">Code</a> | <a href="./../pdf/PackageInfo.pdf" title="PDF US Letter Size">PDF</a> | <a href="./../pdfgreen/PackageInfo.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a> | <a href="./../pdfa4/PackageInfo.pdf" title="PDF A4 Size">PDFA4</a> | <a href="./../pdfa4green/PackageInfo.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>PackageInfo</p> | |
| 22 <p> | |
| 23 </p> | |
| 24 <h2>SYNOPSIS</h2> | |
| 25 <p>use PackageInfo;</p> | |
| 26 <p>use PackageInfo qw(:all);</p> | |
| 27 <p> | |
| 28 </p> | |
| 29 <h2>DESCRIPTION</h2> | |
| 30 <p><strong>PackageInfo</strong> module provides the following functions:</p> | |
| 31 <p> <a href="#getpackagekeyvalue">GetPackageKeyValue</a>, <a href="#ispackagekeynameavailable">IsPackageKeyNameAvailable</a>, <a href="#setpackagekeyvalue">SetPackageKeyValue</a> | |
| 32 </p><p>The functions to set and get package keyvalues not explicitly defined in this module | |
| 33 are implemented using Perl's AUTOLOAD functionality. These methods are generated | |
| 34 on-the-fly for a specified key:</p> | |
| 35 <div class="OptionsBox"> | |
| 36 Set<KeyName>(<KeyValue>); | |
| 37 <br/> $KeyValue = Get<KeyName>();</div> | |
| 38 <p><strong>PackageInfo</strong> module provides functionality to retrieve information about MayaChemTools | |
| 39 package from PackagaInfo.csv which contains the following types key name and values:</p> | |
| 40 <div class="OptionsBox"> | |
| 41 "KeyName","KeyValue" | |
| 42 <br/> "PackageName","MayaChemTools" | |
| 43 <br/> "ReleaseDate","Oct 21, 2010" | |
| 44 <br/> "VersionNumber","7.4" | |
| 45 <br/> "DevSoftwareEnvironment","Cygwin on Windows XP" | |
| 46 <br/> ... ... | |
| 47 <br/> ... ...</div> | |
| 48 <p> | |
| 49 </p> | |
| 50 <h2>FUNCTIONS</h2> | |
| 51 <dl> | |
| 52 <dt><strong><a name="getpackagekeyvalue" class="item"><strong>GetPackageKeyValue</strong></a></strong></dt> | |
| 53 <dd> | |
| 54 <div class="OptionsBox"> | |
| 55 $KeyValue = GetPackageKeyValue($KeyName);</div> | |
| 56 <p>Returns <strong>KeyValue</strong> for a specified <em>KeyName</em>.</p> | |
| 57 </dd> | |
| 58 <dt><strong><a name="ispackagekeynameavailable" class="item"><strong>IsPackageKeyNameAvailable</strong></a></strong></dt> | |
| 59 <dd> | |
| 60 <div class="OptionsBox"> | |
| 61 $Status = IsPackageKeyNameAvailable($KeyName);</div> | |
| 62 <p>Returns 1 or 0 based on whether <em>KeyName</em> is available in package info file.</p> | |
| 63 </dd> | |
| 64 <dt><strong><a name="setpackagekeyvalue" class="item"><strong>SetPackageKeyValue</strong></a></strong></dt> | |
| 65 <dd> | |
| 66 <div class="OptionsBox"> | |
| 67 SetPackageKeyValue($KeyName, $KeyValue);</div> | |
| 68 <p>Sets <em>KeyValue</em> for a <em>KeyName</em>. No data is written to package info file.</p> | |
| 69 </dd> | |
| 70 </dl> | |
| 71 <p> | |
| 72 </p> | |
| 73 <h2>AUTHOR</h2> | |
| 74 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p> | |
| 75 <p> | |
| 76 </p> | |
| 77 <h2>COPYRIGHT</h2> | |
| 78 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p> | |
| 79 <p>This file is part of MayaChemTools.</p> | |
| 80 <p>MayaChemTools is free software; you can redistribute it and/or modify it under | |
| 81 the terms of the GNU Lesser General Public License as published by the Free | |
| 82 Software Foundation; either version 3 of the License, or (at your option) | |
| 83 any later version.</p> | |
| 84 <p> </p><p> </p><div class="DocNav"> | |
| 85 <table width="100%" border=0 cellpadding=0 cellspacing=2> | |
| 86 <tr align="left" valign="top"><td width="33%" align="left"><a href="./ObjectProperty.html" title="ObjectProperty.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./Lexer.html" title="Lexer.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>PackageInfo.pm</strong></td></tr> | |
| 87 </table> | |
| 88 </div> | |
| 89 <br /> | |
| 90 <center> | |
| 91 <img src="../../images/h2o2.png"> | |
| 92 </center> | |
| 93 </body> | |
| 94 </html> |