public interface ISubstanceDescriptor extends IDescriptor
Modifier and Type | Method and Description |
---|---|
DescriptorValue |
calculate(ISubstance substance)
Calculates the descriptor value for the given
ISubstance . |
IDescriptorResult |
getDescriptorResultType()
Returns the specific type of the DescriptorResult object.
|
getDescriptorNames, getParameterNames, getParameters, getParameterType, getSpecification, initialise, setParameters
DescriptorValue calculate(ISubstance substance)
ISubstance
.substance
- An ISubstance
for which this descriptor
should be calculatedDescriptorValue
that contain the
calculated value as well as specification detailsIDescriptorResult 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.
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.
IDescriptorResult
interface indicating
the actual type of values returned by the descriptor in the DescriptorValue
objectCopyright © 2017. All Rights Reserved.