org.openscience.cdk.smsd.global

Class TimeOut

java.lang.Object

org.openscience.cdk.smsd.global.TimeOut

@TestClass(value="org.openscience.cdk.smsd.global.TimeOutTest")
public class TimeOut
extends Object

Class that manages MCS timeout.

Author:

Syed Asad Rahman

Method Summary

Methods

Modifier and Type	Method and Description
static TimeOut	getInstance() Get Instance of the timeout.
double	getTimeOut() Return cutoff value for time out.
boolean	isTimeOutFlag() Return true if its a timeout else return false.
void	setTimeOut(double timeout) set cutoff value for time out eg.
void	setTimeOutFlag(boolean timeOut) Set true if timeout occures else false

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

@TestMethod(value="testGetInstance")
public static TimeOut getInstance()

Get Instance of the timeout. This starts the timeout counter.

Returns:

Instance

setTimeOut

@TestMethod(value="testSetTimeOut")
public void setTimeOut(double timeout)

set cutoff value for time out eg. -1 for infinite and 0.23 for 23 seconds.

Parameters:

timeout -

getTimeOut

@TestMethod(value="testSetTimeOut")
public double getTimeOut()

Return cutoff value for time out.

Returns:

time out cutoff value

isTimeOutFlag

@TestMethod(value="testIsTimeOutFlag")
public boolean isTimeOutFlag()

Return true if its a timeout else return false.

Returns:

the timeout flag

setTimeOutFlag

@TestMethod(value="testSetTimeOutFlag")
public void setTimeOutFlag(boolean timeOut)

Set true if timeout occures else false

Parameters:

timeOut - the timeout flag to set