@TestClass(value="org.openscience.cdk.qsar.descriptors.molecular.TPSADescriptorTest") public class TPSADescriptor extends Object implements IMolecularDescriptor
This descriptor uses these parameters:
Name | Default | Description |
checkAromaticity | false | If true, it will check aromaticity |
Constructor and Description |
---|
TPSADescriptor()
Constructor for the TPSADescriptor object.
|
Modifier and Type | Method and Description |
---|---|
DescriptorValue |
calculate(IAtomContainer atomContainer)
Calculates the TPSA for an atom container.
|
String[] |
getDescriptorNames()
Returns an array of names for each descriptor value calculated.
|
IDescriptorResult |
getDescriptorResultType()
Returns the specific type of the DescriptorResult object.
|
String[] |
getParameterNames()
Gets the parameterNames attribute of the TPSADescriptor object.
|
Object[] |
getParameters()
Gets the parameters attribute of the TPSADescriptor object.
|
Object |
getParameterType(String name)
Gets the parameterType attribute of the TPSADescriptor object.
|
DescriptorSpecification |
getSpecification()
Gets the specification attribute of the TPSADescriptor object.
|
void |
setParameters(Object[] params)
Sets the parameters attribute of the TPSADescriptor object.
|
public TPSADescriptor()
@TestMethod(value="testGetSpecification") public DescriptorSpecification getSpecification()
getSpecification
in interface IDescriptor
@TestMethod(value="testSetParameters_arrayObject") public void setParameters(Object[] params) throws CDKException
setParameters
in interface IDescriptor
params
- The parameter value (TRUE or FALSE)CDKException
- if the supplied parameter is not of type BooleangetParameters()
@TestMethod(value="testGetParameters") public Object[] getParameters()
getParameters
in interface IDescriptor
setParameters(java.lang.Object[])
@TestMethod(value="testNamesConsistency") public String[] getDescriptorNames()
IDescriptor
ALOGPDescriptor
the return array will have a single element
getDescriptorNames
in interface IDescriptor
@TestMethod(value="testCalculate_IAtomContainer") public DescriptorValue calculate(IAtomContainer atomContainer)
CDKHydrogenAdder.addImplicitHydrogens(IAtomContainer)
or
AtomContainerManipulator.convertImplicitToExplicitHydrogens(IAtomContainer)
.calculate
in interface IMolecularDescriptor
atomContainer
- The AtomContainer whose TPSA is to be calculated@TestMethod(value="testGetDescriptorResultType") public IDescriptorResult getDescriptorResultType()
DescriptorValue
object. Note that the same result
can be achieved by interrogating the DescriptorValue
object; this method
allows you to do the same thing, without actually calculating the descriptor.getDescriptorResultType
in interface IMolecularDescriptor
IDescriptorResult
interface indicating
the actual type of values returned by the descriptor in the DescriptorValue
object@TestMethod(value="testGetParameterNames") public String[] getParameterNames()
getParameterNames
in interface IDescriptor
@TestMethod(value="testGetParameterType_String") public Object getParameterType(String name)
getParameterType
in interface IDescriptor
name
- Description of the Parameter