Mercurial > repos > deepakjadmin > mayatool3_test3
view mayachemtools/docs/modules/html/PackageInfo.html @ 9:ab29fa5c8c1f draft default tip
Uploaded
| author | deepakjadmin |
|---|---|
| date | Thu, 15 Dec 2016 14:18:03 -0500 |
| parents | 73ae111cf86f |
| children |
line wrap: on
line source
<html> <head> <title>MayaChemTools:Documentation:PackageInfo.pm</title> <meta http-equiv="content-type" content="text/html;charset=utf-8"> <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.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/> <div class="DocNav"> <table width="100%" border=0 cellpadding=0 cellspacing=2> <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> </table> </div> <p> </p> <h2>NAME</h2> <p>PackageInfo</p> <p> </p> <h2>SYNOPSIS</h2> <p>use PackageInfo;</p> <p>use PackageInfo qw(:all);</p> <p> </p> <h2>DESCRIPTION</h2> <p><strong>PackageInfo</strong> module provides the following functions:</p> <p> <a href="#getpackagekeyvalue">GetPackageKeyValue</a>, <a href="#ispackagekeynameavailable">IsPackageKeyNameAvailable</a>, <a href="#setpackagekeyvalue">SetPackageKeyValue</a> </p><p>The functions to set and get package keyvalues not explicitly defined in this module are implemented using Perl's AUTOLOAD functionality. These methods are generated on-the-fly for a specified key:</p> <div class="OptionsBox"> Set<KeyName>(<KeyValue>); <br/> $KeyValue = Get<KeyName>();</div> <p><strong>PackageInfo</strong> module provides functionality to retrieve information about MayaChemTools package from PackagaInfo.csv which contains the following types key name and values:</p> <div class="OptionsBox"> "KeyName","KeyValue" <br/> "PackageName","MayaChemTools" <br/> "ReleaseDate","Oct 21, 2010" <br/> "VersionNumber","7.4" <br/> "DevSoftwareEnvironment","Cygwin on Windows XP" <br/> ... ... <br/> ... ...</div> <p> </p> <h2>FUNCTIONS</h2> <dl> <dt><strong><a name="getpackagekeyvalue" class="item"><strong>GetPackageKeyValue</strong></a></strong></dt> <dd> <div class="OptionsBox"> $KeyValue = GetPackageKeyValue($KeyName);</div> <p>Returns <strong>KeyValue</strong> for a specified <em>KeyName</em>.</p> </dd> <dt><strong><a name="ispackagekeynameavailable" class="item"><strong>IsPackageKeyNameAvailable</strong></a></strong></dt> <dd> <div class="OptionsBox"> $Status = IsPackageKeyNameAvailable($KeyName);</div> <p>Returns 1 or 0 based on whether <em>KeyName</em> is available in package info file.</p> </dd> <dt><strong><a name="setpackagekeyvalue" class="item"><strong>SetPackageKeyValue</strong></a></strong></dt> <dd> <div class="OptionsBox"> SetPackageKeyValue($KeyName, $KeyValue);</div> <p>Sets <em>KeyValue</em> for a <em>KeyName</em>. No data is written to package info file.</p> </dd> </dl> <p> </p> <h2>AUTHOR</h2> <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p> <p> </p> <h2>COPYRIGHT</h2> <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p> <p>This file is part of MayaChemTools.</p> <p>MayaChemTools is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.</p> <p> </p><p> </p><div class="DocNav"> <table width="100%" border=0 cellpadding=0 cellspacing=2> <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> </table> </div> <br /> <center> <img src="../../images/h2o2.png"> </center> </body> </html>