Package adams.flow.standalone.rats.output

Class QueueDistribute

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.standalone.rats.output.AbstractRatOutput

adams.flow.standalone.rats.output.QueueDistribute

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<AbstractRatOutput>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, adams.flow.control.StorageUpdater, RatOutput, Serializable

public class QueueDistribute
extends AbstractRatOutput
implements adams.flow.control.StorageUpdater

Enqueues the incoming data in the queues in internal storage, performing load-balancing by iterating through them.

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
 

-storage-name <adams.flow.control.StorageName> [-storage-name ...] (property: storageNames)
    The names of the queues in the internal storage.
    default: 
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected int	m_Current	the current queue to serve.
protected adams.flow.control.StorageName[]	m_StorageNames	the names of the queues in the internal storage.

Fields inherited from class adams.flow.standalone.rats.output.AbstractRatOutput

m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_Input, m_LoggingPrefix, m_Owner, m_Stopped, m_VariablesUpdated

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
QueueDistribute()

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the type of data that gets accepted.
protected String	check()	Hook method for performing checks.
void	defineOptions()	Adds options to the internal list of options.
protected String	doTransmit()	Performs the actual transmission.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
adams.flow.control.StorageName[]	getStorageNames()	Returns the names for the queues in the internal storage.
String	globalInfo()	Returns a string describing the object.
boolean	isUpdatingStorage()	Returns whether storage items are being updated.
protected void	reset()	Resets the scheme.
void	setStorageNames(adams.flow.control.StorageName[] value)	Sets the names for the queues in the internal storage.
String	storageNamesTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.standalone.rats.output.AbstractRatOutput

backupState, canInput, cleanUp, configureLogger, doWait, findVariables, getAdditionalInformation, getFullName, getOwner, getQueue, getVariables, handleException, initialize, initTransmission, input, isBackedUp, isStopped, pruneBackup, pruneBackup, restoreState, setOwner, setUp, shallowCopy, shallowCopy, stopExecution, transmit, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, 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.Destroyable

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_StorageNames

protected adams.flow.control.StorageName[] m_StorageNames

the names of the queues in the internal storage.

m_Current

protected int m_Current

the current queue to serve.

Constructor Detail

QueueDistribute

public QueueDistribute()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

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

reset

protected void reset()

Resets the scheme.

Overrides:

reset in class adams.core.option.AbstractOptionHandler

setStorageNames

public void setStorageNames(adams.flow.control.StorageName[] value)

Sets the names for the queues in the internal storage.

Parameters:

value - the names

getStorageNames

public adams.flow.control.StorageName[] getStorageNames()

Returns the names for the queues in the internal storage.

Returns:

the names

storageNamesTipText

public String storageNamesTipText()

Returns the tip text for this property.

Returns:

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

isUpdatingStorage

public boolean isUpdatingStorage()

Returns whether storage items are being updated.

Specified by:

isUpdatingStorage in interface adams.flow.control.StorageUpdater

Returns:

true if storage items are updated

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 AbstractRatOutput

Returns:

null if no info available, otherwise short string

accepts

public Class[] accepts()

Returns the type of data that gets accepted.

Specified by:

accepts in interface RatOutput

Specified by:

accepts in class AbstractRatOutput

Returns:

the type of data

check

protected String check()

Hook method for performing checks.

Overrides:

check in class AbstractRatOutput

Returns:

null if successful, otherwise error message

doTransmit

protected String doTransmit()

Performs the actual transmission.

Specified by:

doTransmit in class AbstractRatOutput

Returns:

null if successful, otherwise error message