Package adams.flow.standalone.rats.input

Interface PollingRatInput

All Superinterfaces:

adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.option.OptionHandler, RatInput, adams.core.Stoppable, adams.core.StoppableWithFeedback

All Known Implementing Classes:

AbstractPollingRatInput, InputPolling

public interface PollingRatInput
extends RatInput

Interface for RatInput schemes that perform polling.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
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 interface adams.core.AdditionalInformationHandler

getAdditionalInformation

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, 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

Method Detail

setWaitPoll

void setWaitPoll(int value)

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

Parameters:

value - the number of milli-seconds

getWaitPoll

int getWaitPoll()

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

Returns:

the number of milli-seconds

waitPollTipText

String waitPollTipText()

Returns the tip text for this property.

Returns:

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