Mercurial > repos > deepakjadmin > mayatool3_test3
view mayachemtools/docs/modules/html/AtomsCountDescriptors.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:MolecularDescriptors::AtomsCountDescriptors.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="./Matrix.html" title="Matrix.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./Fsp3CarbonsDescriptors.html" title="Fsp3CarbonsDescriptors.html">Next</a></td><td width="34%" align="middle"><strong>MolecularDescriptors::AtomsCountDescriptors.pm</strong></td><td width="33%" align="right"><a href="././code/AtomsCountDescriptors.html" title="View source code">Code</a> | <a href="./../pdf/AtomsCountDescriptors.pdf" title="PDF US Letter Size">PDF</a> | <a href="./../pdfgreen/AtomsCountDescriptors.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a> | <a href="./../pdfa4/AtomsCountDescriptors.pdf" title="PDF A4 Size">PDFA4</a> | <a href="./../pdfa4green/AtomsCountDescriptors.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr> </table> </div> <p> </p> <h2>NAME</h2> <p>AtomsCountDescriptors</p> <p> </p> <h2>SYNOPSIS</h2> <p>use MolecularDescriptors::AtomsCountDescriptors;</p> <p>use MolecularDescriptors::AtomsCountDescriptors qw(:all);</p> <p> </p> <h2>DESCRIPTION</h2> <p><strong>AtomsCountDescriptors</strong> class provides the following methods:</p> <p> <a href="#new">new</a>, <a href="#generatedescriptors">GenerateDescriptors</a>, <a href="#getdescriptornames">GetDescriptorNames</a>, <a href="#stringifyatomscountdescriptors">StringifyAtomsCountDescriptors</a> </p><p><strong>AtomsCountDescriptors</strong> is derived from <strong>MolecularDescriptors</strong> class which in turn is derived from <strong>ObjectProperty</strong> base class that provides methods not explicitly defined in <strong>AtomsCountDescriptors</strong>, <strong>MolecularDescriptors</strong> or <strong>ObjectProperty</strong> classes using Perl's AUTOLOAD functionality. These methods are generated on-the-fly for a specified object property:</p> <div class="OptionsBox"> Set<PropertyName>(<PropertyValue>); <br/> $PropertyValue = Get<PropertyName>(); <br/> Delete<PropertyName>();</div> <p><strong>AtomsCountDescriptors</strong> class counts the number of atoms and heavy atoms in a molecule corresponding to total number of atom and non-hydrogen atoms respectively.</p> <p> </p> <h2>METHODS</h2> <dl> <dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt> <dd> <div class="OptionsBox"> $NewAtomsCountDescriptors = new MolecularDescriptors:: AtomsCountDescriptors( %NamesAndValues);</div> <p>Using specified <em>AtomsCountDescriptors</em> property names and values hash, <strong>new</strong> method creates a new object and returns a reference to newly created <strong>AtomsCountDescriptors</strong> object. By default, the following properties are initialized:</p> <div class="OptionsBox"> Molecule = '' <br/> Type = 'AtomsCount'</div> <div class="OptionsBox"> @DescriptorNames = ('Atoms', 'HeavyAtoms') <br/> @DescriptorValues = ('None', 'None')</div> <p>Examples:</p> <div class="OptionsBox"> $AtomsCountDescriptors = new AtomsCountDescriptors( 'Molecule' => $Molecule);</div> <div class="OptionsBox"> $AtomsCountDescriptors = new AtomsCountDescriptors();</div> <div class="OptionsBox"> $AtomsCountDescriptors->SetMolecule($Molecule); <br/> $AtomsCountDescriptors->GenerateDescriptors(); <br/> print "AtomsCountDescriptors: $AtomsCountDescriptors\n";</div> </dd> <dt><strong><a name="generatedescriptors" class="item"><strong>GenerateDescriptors</strong></a></strong></dt> <dd> <div class="OptionsBox"> $AtomsCountDescriptors->GenerateDescriptors();</div> <p>Calculates number of atoms and heavy atoms in a molecule and returns <em>AtomsCountDescriptors</em>.</p> </dd> <dt><strong><a name="getdescriptornames" class="item"><strong>GetDescriptorNames</strong></a></strong></dt> <dd> <div class="OptionsBox"> @DescriptorNames = $AtomsCountDescriptors->GetDescriptorNames(); <br/> @DescriptorNames = MolecularDescriptors::AtomsCountDescriptors:: GetDescriptorNames();</div> <p>Returns all available descriptor names as an array.</p> </dd> <dt><strong><a name="stringifyatomscountdescriptors" class="item"><strong>StringifyAtomsCountDescriptors</strong></a></strong></dt> <dd> <div class="OptionsBox"> $String = $AtomsCountDescriptors->StringifyAtomsCountDescriptors();</div> <p>Returns a string containing information about <em>AtomsCountDescriptors</em> object.</p> </dd> </dl> <p> </p> <h2>AUTHOR</h2> <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p> <p> </p> <h2>SEE ALSO</h2> <p><a href="./MolecularDescriptors.html">MolecularDescriptors.pm</a>, <a href="./MolecularDescriptorsGenerator.html">MolecularDescriptorsGenerator.pm</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="./Matrix.html" title="Matrix.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./Fsp3CarbonsDescriptors.html" title="Fsp3CarbonsDescriptors.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>MolecularDescriptors::AtomsCountDescriptors.pm</strong></td></tr> </table> </div> <br /> <center> <img src="../../images/h2o2.png"> </center> </body> </html>