~ubuntu-branches/ubuntu/trusty/cdk/trusty-proposed

« back to all changes in this revision

Viewing changes to src/org/openscience/cdk/qsar/IBondDescriptor.java

  • Committer: Bazaar Package Importer
  • Author(s): Paul Cager
  • Date: 2008-04-09 21:17:53 UTC
  • Revision ID: james.westby@ubuntu.com-20080409211753-46lmjw5z8mx5pd8d
Tags: upstream-1.0.2
ImportĀ upstreamĀ versionĀ 1.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/* $RCSfile$
 
2
 * $Author: egonw $
 
3
 * $Date: 2006-03-29 10:27:08 +0200 (Wed, 29 Mar 2006) $
 
4
 * $Revision: 5855 $
 
5
 * 
 
6
 * Copyright (C) 2002-2007  The Chemistry Development Kit (CDK) project
 
7
 * 
 
8
 * Contact: cdk-devel@lists.sourceforge.net
 
9
 * 
 
10
 * This program is free software; you can redistribute it and/or
 
11
 * modify it under the terms of the GNU Lesser General Public License
 
12
 * as published by the Free Software Foundation; either version 2.1
 
13
 * of the License, or (at your option) any later version.
 
14
 * 
 
15
 * This program is distributed in the hope that it will be useful,
 
16
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
18
 * GNU Lesser General Public License for more details.
 
19
 * 
 
20
 * You should have received a copy of the GNU Lesser General Public License
 
21
 * along with this program; if not, write to the Free Software
 
22
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 
23
 */
 
24
package org.openscience.cdk.qsar;
 
25
 
 
26
import org.openscience.cdk.exception.CDKException;
 
27
import org.openscience.cdk.interfaces.IAtomContainer;
 
28
import org.openscience.cdk.interfaces.IBond;
 
29
 
 
30
/**
 
31
 * Classes that implement this interface are QSAR descriptor calculators.
 
32
 *
 
33
 * @cdk.module qsar
 
34
 */
 
35
public interface IBondDescriptor extends IDescriptor {
 
36
    
 
37
    /** 
 
38
     * Calculates the descriptor value for the given IBond.
 
39
     *
 
40
     * @param  bond         A {@link IBond} for which this descriptor
 
41
     *                      should be calculated
 
42
     * @return              An object of {@link DescriptorValue} that contain the 
 
43
     *                      calculated value as well as specification details
 
44
     * @throws CDKException if an error occurs during calculation. See 
 
45
     *                      documentation for individual descriptors
 
46
     */
 
47
    public DescriptorValue calculate(IBond bond, IAtomContainer container) throws CDKException;
 
48
    
 
49
}
 
50