org.openscience.cdk.qsar.descriptors.atomic

Class CovalentRadiusDescriptor

java.lang.Object

org.openscience.cdk.qsar.AbstractAtomicDescriptor

org.openscience.cdk.qsar.descriptors.atomic.CovalentRadiusDescriptor

All Implemented Interfaces:

IAtomicDescriptor, IDescriptor

public class CovalentRadiusDescriptor
extends AbstractAtomicDescriptor
implements IAtomicDescriptor

This class returns the covalent radius of a given atom.

Parameters for this descriptor:

Name	Default	Description
		no parameters

Author:

Miguel Rojas

Dictionary pointer(s):

covalentradius in the QSAR.sf.net Descriptors Dictionary [qsar-descriptors:covalentradius]

Source code:

master

Belongs to CDK module:

qsaratomic

Created on:

2006-05-17

Constructor Summary

Constructors

Constructor and Description
CovalentRadiusDescriptor() Constructor for the CovalentRadiusDescriptor object.

Method Summary

Methods

Modifier and Type	Method and Description
DescriptorValue	calculate(IAtom atom, IAtomContainer container) This method calculates the Covalent radius of an atom.
String[]	getDescriptorNames() Returns an array of names for each descriptor value calculated.
String[]	getParameterNames() Gets the parameterNames attribute of the VdWRadiusDescriptor object.
Object[]	getParameters() Gets the parameters attribute of the VdWRadiusDescriptor object.
Object	getParameterType(String name) Gets the parameterType attribute of the VdWRadiusDescriptor object.
DescriptorSpecification	getSpecification() Returns a Map which specifies which descriptor is implemented by this class.
void	initialise(IChemObjectBuilder builder) Default implementation of initialise allows optional override.
void	setParameters(Object[] params) This descriptor does have any parameter.

Methods inherited from class org.openscience.cdk.qsar.AbstractAtomicDescriptor

cacheDescriptorValue, getCachedDescriptorValue, isCachedAtomContainer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openscience.cdk.qsar.IDescriptor

initialise

Constructor Detail

CovalentRadiusDescriptor

public CovalentRadiusDescriptor()
                         throws IOException,
                                ClassNotFoundException

Constructor for the CovalentRadiusDescriptor object.

Throws:

IOException - if an error occurs when reading atom type information

ClassNotFoundException - if an error occurs during tom typing

Method Detail

getSpecification

public DescriptorSpecification getSpecification()

Returns a Map which specifies which descriptor is implemented by this class. These fields are used in the map:

• Specification-Reference: refers to an entry in a unique dictionary
• Implementation-Title: anything
• Implementation-Identifier: a unique identifier for this version of this class
• Implementation-Vendor: CDK, JOELib, or anything else

Specified by:

getSpecification in interface IDescriptor

Returns:

An object containing the descriptor specification

setParameters

public void setParameters(Object[] params)
                   throws CDKException

This descriptor does have any parameter.

Specified by:

setParameters in interface IDescriptor

Parameters:

params - An array of Object containing the parameters for this descriptor

Throws:

CDKException - if invalid number of type of parameters are passed to it

See Also:

IDescriptor.getParameters()

getParameters

public Object[] getParameters()

Gets the parameters attribute of the VdWRadiusDescriptor object.

Specified by:

getParameters in interface IDescriptor

Returns:

The parameters value

See Also:

setParameters(java.lang.Object[])

getDescriptorNames

public String[] getDescriptorNames()

Description copied from interface: IDescriptor

Returns an array of names for each descriptor value calculated. Many descriptors return multiple values. In general it is useful for the descriptor to indicate the names for each value. In many cases, these names can be as simple as X1, X2, ..., XN where X is a prefix and 1, 2, ..., N are the indices. On the other hand it is also possible to return other arbitrary names, which should be documented in the Javadocs for the descriptor (e.g., the CPSA descriptor). Note that by default if a descriptor returns a single value (such as ALOGPDescriptor the return array will have a single element

Specified by:

getDescriptorNames in interface IDescriptor

Returns:

An array of descriptor names, equal in length to the number of descriptor calculated..

calculate

public DescriptorValue calculate(IAtom atom,
                        IAtomContainer container)

This method calculates the Covalent radius of an atom.

Specified by:

calculate in interface IAtomicDescriptor

Parameters:

atom - The IAtom for which the DescriptorValue is requested

container - The IAtomContainer for which the descriptor is to be calculated

Returns:

The Covalent radius of the atom

getParameterNames

public String[] getParameterNames()

Gets the parameterNames attribute of the VdWRadiusDescriptor object.

Specified by:

getParameterNames in interface IDescriptor

Returns:

The parameterNames value

getParameterType

public Object getParameterType(String name)

Gets the parameterType attribute of the VdWRadiusDescriptor object.

Specified by:

getParameterType in interface IDescriptor

Parameters:

name - Description of the Parameter

Returns:

An Object of class equal to that of the parameter being requested

initialise

public void initialise(IChemObjectBuilder builder)

Default implementation of initialise allows optional override.

Specified by:

initialise in interface IDescriptor

Parameters:

builder - chem object build