Package org.openscience.cdk.qsar.descriptors.substance

Interface ISubstanceDescriptor

All Superinterfaces:
IDescriptor
All Known Implementing Classes:
OxygenAtomCountDescriptor
public interface ISubstanceDescriptor extends IDescriptor
Classes that implement this interface are QSAR substance calculators.

  • Method Details

    • calculate

      DescriptorValue calculate(ISubstance substance)
      Calculates the descriptor value for the given ISubstance.
      Parameters:
      substance - An ISubstance for which this descriptor should be calculated
      Returns:
      An object of DescriptorValue that contain the calculated value as well as specification details

    • getDescriptorResultType

      IDescriptorResult getDescriptorResultType()
      Returns the specific type of the DescriptorResult object. The return value from this method really indicates what type of result will be obtained from the 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.

      Additionally, the length indicated by the result type must match the actual length of a descriptor calculated with the current parameters. Typically, the length of array result types vary with the values of the parameters. See IDescriptor for more details.

      Returns:
      an object that implements the IDescriptorResult interface indicating the actual type of values returned by the descriptor in the DescriptorValue object