Package chemaxon.alignment
Class AlignmentBase
java.lang.Object
chemaxon.alignment.AlignmentBase
- All Implemented Interfaces:
Licensable
- Direct Known Subclasses:
Alignment,AlignOnPairedAtoms,MinMaxDistance
@PublicApi
public sealed class AlignmentBase
extends Object
implements Licensable
permits Alignment, AlignOnPairedAtoms, MinMaxDistance
Base class for the alignment algorithms. It contains the common data structures and methods.
It is not intended to be used directly by the users.
-
Method Summary
Modifier and TypeMethodDescriptiondoubleReturns the maximum gradient component limit used for the optimization.Returns the collection of alignment molecules.Returns the node color used for the alignment.Returns the node type used for the alignment.intintbooleanChecks if the required license is available for using this class or product.voidSets the maximum gradient component limit used for the optimization.voidsetFlexibleRingSize(int s) Sets the maximum gradient component limit used for the optimization.voidSets the current license environment identifier.voidvoidsetProgressMonitor(ProgressMonitor progressMonitor) Sets the progress monitor for the alignment.voidsetProperty(AlignmentProperties props) Sets the properties for the alignment.voidSets the proximity potential type used for the alignment.voidsetStepLimit(int stepLimit) voidsetTimeLimit(int timeLimit) Sets the maximum time used for the alignment.
-
Method Details
-
setProperty
Sets the properties for the alignment. The properties are used to configure the alignment algorithm. The properties are set to the factory and the factory is used to create the alignment molecules.- Parameters:
props- the properties to set
-
getMaxGradLimit
public double getMaxGradLimit()Returns the maximum gradient component limit used for the optimization.- Returns:
- the maximum gradient component limit
-
getNodeType
Returns the node type used for the alignment.- Returns:
- the node type
-
getNodeColor
Returns the node color used for the alignment.- Returns:
- the node color
-
setFlexibleRingSize
public void setFlexibleRingSize(int s) Sets the maximum gradient component limit used for the optimization.- Parameters:
s- the maximum gradient component limit
-
setFlexibleRingRotatableBondCount
public void setFlexibleRingRotatableBondCount(int b) Sets the maximum gradient component limit used for the optimization.- Parameters:
b- the maximum gradient component limit
-
getMolecules
Returns the collection of alignment molecules.- Returns:
- the collection of alignment molecules
-
isLicensed
public boolean isLicensed()Description copied from interface:LicensableChecks if the required license is available for using this class or product.- Specified by:
isLicensedin interfaceLicensable- Returns:
- true if this software component is correctly licensed
-
setLicenseEnvironment
Description copied from interface:LicensableSets the current license environment identifier. For internal use only!- Specified by:
setLicenseEnvironmentin interfaceLicensable- Parameters:
env- license environment. It is string identifier of a certain integration environment.
-
getStepLimit
public int getStepLimit() -
setStepLimit
public void setStepLimit(int stepLimit) -
getTimeLimit
public int getTimeLimit() -
setNodeType
-
setTimeLimit
public void setTimeLimit(int timeLimit) Sets the maximum time used for the alignment. If reached returns the partly aligned structures.- Parameters:
timeLimit- time limit in millisecond. if -1 then disabled.
-
setProgressMonitor
Sets the progress monitor for the alignment. The progress monitor is used to report the progress of the alignment.- Parameters:
progressMonitor- the progress monitor to set
-
setProximity
Sets the proximity potential type used for the alignment.- Parameters:
pot- the proximity potential type to set
-