TPTP 4.1.0 Platform Project
Public API Specification

org.eclipse.tptp.platform.analysis.engine
Interface IAlgorithmRunner

All Superinterfaces:
org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier
All Known Subinterfaces:
SingleFileRunner
All Known Implementing Classes:
IAlgorithmRunnerImpl, SingleFileRunnerImpl

public interface IAlgorithmRunner
extends org.eclipse.emf.ecore.EObject

A representation of the model object 'IAlgorithm Runner'.

The following features are supported:

See Also:
EnginePackage.getIAlgorithmRunner()

Method Summary
 int estimateWork(IAnalysisScope scope, IAlgorithm[] algorithms, IEngine engine)
           Returns the number of units of work expected to be performed by this runner to execute enabled algorithms on the given analysis scope.
 java.lang.String getName()
          Returns the value of the 'Name' attribute.
 void run(IEngine engine, IAlgorithm[] algorithms, org.eclipse.core.resources.IResource[] resources, IEngineListener listener)
           
 void setName(java.lang.String value)
          Sets the value of the 'Name' attribute.
 boolean supports(IAlgorithm algorithm)
           
 
Methods inherited from interface org.eclipse.emf.ecore.EObject
eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset
 
Methods inherited from interface org.eclipse.emf.common.notify.Notifier
eAdapters, eDeliver, eNotify, eSetDeliver
 

Method Detail

getName

public java.lang.String getName()
Returns the value of the 'Name' attribute.

If the meaning of the 'Name' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Name' attribute.
See Also:
setName(String), EnginePackage.getIAlgorithmRunner_Name()

setName

public void setName(java.lang.String value)
Sets the value of the 'Name' attribute.

Parameters:
value - the new value of the 'Name' attribute.
See Also:
getName()

run

public void run(IEngine engine,
                IAlgorithm[] algorithms,
                org.eclipse.core.resources.IResource[] resources,
                IEngineListener listener)


supports

public boolean supports(IAlgorithm algorithm)


estimateWork

public int estimateWork(IAnalysisScope scope,
                        IAlgorithm[] algorithms,
                        IEngine engine)
Returns the number of units of work expected to be performed by this runner to execute enabled algorithms on the given analysis scope.


TPTP 4.1.0 Platform Project
Public API Specification