Package adams.flow.standalone.rats.input

Class AbstractPollingRatInput

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.input.AbstractRatInput

adams.flow.standalone.rats.input.AbstractPollingRatInput

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<AbstractRatInput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, PollingRatInput, RatInput, Serializable

public abstract class AbstractPollingRatInput
extends AbstractRatInput
implements PollingRatInput

Ancestor for rat inputs that perform polling.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_WaitPoll	the waiting period in msec before polling again.

Fields inherited from class adams.flow.standalone.rats.input.AbstractRatInput

m_LoggingPrefix, m_Owner, m_ReceptionInterrupted, m_ReceptionRunning, m_Stopped

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractPollingRatInput()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
int	getWaitPoll()	Returns the number of milli-seconds to wait before polling again.
void	setWaitPoll(int value)	Sets the number of milli-seconds to wait before polling.
String	waitPollTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.standalone.rats.input.AbstractRatInput

canReceive, check, cleanUp, configureLogger, doReceive, doWait, generates, getAdditionalInformation, getFullName, getOwner, getQueue, getReceptionInterrupted, handleException, hasPendingOutput, initialize, initReception, interruptReception, isReceptionRunning, isStopped, output, receive, setOwner, setUp, shallowCopy, shallowCopy, stopExecution, updatePrefix

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.flow.standalone.rats.input.RatInput

generates, getFullName, getOwner, getReceptionInterrupted, hasPendingOutput, initReception, interruptReception, isReceptionRunning, isStopped, output, receive, setOwner, setUp, stopExecution

Field Detail

m_WaitPoll

protected int m_WaitPoll

the waiting period in msec before polling again.

Constructor Detail

AbstractPollingRatInput

public AbstractPollingRatInput()

Method Detail

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setWaitPoll

public void setWaitPoll(int value)

Sets the number of milli-seconds to wait before polling.

Specified by:

setWaitPoll in interface PollingRatInput

Parameters:

value - the number of milli-seconds

getWaitPoll

public int getWaitPoll()

Returns the number of milli-seconds to wait before polling again.

Specified by:

getWaitPoll in interface PollingRatInput

Returns:

the number of milli-seconds

waitPollTipText

public String waitPollTipText()

Returns the tip text for this property.

Specified by:

waitPollTipText in interface PollingRatInput

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface adams.core.QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractRatInput

Returns:

null if no info available, otherwise short string