Class BondSigmaElectronegativityDescriptor
java.lang.Object
org.openscience.cdk.qsar.AbstractBondDescriptor
org.openscience.cdk.qsar.descriptors.bond.BondSigmaElectronegativityDescriptor
- All Implemented Interfaces:
IBondDescriptor, IDescriptor
public class BondSigmaElectronegativityDescriptor
extends AbstractBondDescriptor
implements IBondDescriptor
The calculation of bond-Polarizability is calculated determining the
difference the Sigma electronegativity on atoms A and B of a bond.
| Name | Default | Description |
| bondPosition | 0 | The position of the target bond |
- Author:
- Miguel Rojas
- See Also:
- Dictionary pointer(s):
- bondSigmaElectronegativity in the QSAR.sf.net Descriptors Dictionary [qsar-descriptors:bondSigmaElectronegativity]
- Created on:
- 2006-05-08
-
Constructor Summary
ConstructorsConstructorDescriptionConstructor for the BondSigmaElectronegativityDescriptor object. -
Method Summary
Modifier and TypeMethodDescriptioncalculate(IBond aBond, IAtomContainer atomContainer) The method calculates the sigma electronegativity of a given bond It is needed to call the addExplicitHydrogensToSatisfyValency method from the class tools.HydrogenAdder.String[]Returns an array of names for each descriptor value calculated.String[]Gets the parameterNames attribute of the BondSigmaElectronegativityDescriptor object.Object[]Gets the parameters attribute of the BondSigmaElectronegativityDescriptor object.getParameterType(String name) Gets the parameterType attribute of the BondSigmaElectronegativityDescriptor object.Gets the specification attribute of the BondSigmaElectronegativityDescriptor object.voidinitialise(IChemObjectBuilder builder) Default implementation of initialise allows optional override.voidsetParameters(Object[] params) This descriptor does have any parameter.Methods inherited from class AbstractBondDescriptor
cacheDescriptorValue, getCachedDescriptorValue, isCachedAtomContainerModifier and TypeMethodDescriptionvoidcacheDescriptorValue(IBond bond, IAtomContainer container, IDescriptorResult doubleResult) Caches a DescriptorValue for a given IBond.Returns the cached DescriptorValue for the given IBond.booleanisCachedAtomContainer(IAtomContainer container) Returns true if the cached IDescriptorResult's are for the given IAtomContainer.
-
Constructor Details
-
BondSigmaElectronegativityDescriptor
public BondSigmaElectronegativityDescriptor()Constructor for the BondSigmaElectronegativityDescriptor object.
-
-
Method Details
-
getSpecification
Gets the specification attribute of the BondSigmaElectronegativityDescriptor object.- Specified by:
getSpecificationin interfaceIDescriptor- Returns:
- The specification value
-
setParameters
This descriptor does have any parameter.- Specified by:
setParametersin interfaceIDescriptor- 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:
-
getParameters
Gets the parameters attribute of the BondSigmaElectronegativityDescriptor object.- Specified by:
getParametersin interfaceIDescriptor- Returns:
- The parameters value
- See Also:
-
getDescriptorNames
Description copied from interface:IDescriptorReturns 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 asALOGPDescriptorthe return array will have a single element- Specified by:
getDescriptorNamesin interfaceIDescriptor- Returns:
- An array of descriptor names, equal in length to the number of descriptor calculated..
-
calculate
The method calculates the sigma electronegativity of a given bond It is needed to call the addExplicitHydrogensToSatisfyValency method from the class tools.HydrogenAdder.- Specified by:
calculatein interfaceIBondDescriptor- Parameters:
aBond- AIBondfor which this descriptor should be calculatedatomContainer- AtomContainer- Returns:
- return the sigma electronegativity
-
getParameterNames
Gets the parameterNames attribute of the BondSigmaElectronegativityDescriptor object.- Specified by:
getParameterNamesin interfaceIDescriptor- Returns:
- The parameterNames value
-
getParameterType
Gets the parameterType attribute of the BondSigmaElectronegativityDescriptor object.- Specified by:
getParameterTypein interfaceIDescriptor- Parameters:
name- Description of the Parameter- Returns:
- An Object of class equal to that of the parameter being requested
-
initialise
Default implementation of initialise allows optional override.- Specified by:
initialisein interfaceIDescriptor- Parameters:
builder- chem object build
-