Package adams.flow.standalone.rats.output

Interface RatOutput

All Superinterfaces:

adams.core.AdditionalInformationHandler, adams.core.Destroyable, adams.core.option.OptionHandler, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener

All Known Implementing Classes:

AbstractMetaRatOutput, AbstractRatOutput, BinaryFileWriter, Branch, CallableActor, ContainerValuePicker, DistributedEnQueue, DummyOutput, EnQueue, Exec, FileMover, OutputWithCallableTransformer, OutputWithExternalTransformer, Publish, QueueDistribute, RedisAction, RedisPublish, SendEmail, Serialize, SimpleContainerContent, Socket, Switch, TextWriter, WebserviceOutput, WebsocketOutput

public interface RatOutput
extends adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, adams.core.option.OptionHandler, adams.core.AdditionalInformationHandler

Interface for output transmitters for the RATS framework.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
Class[]	accepts()	Returns the type of data that gets accepted.
boolean	canInput()	Whether input can be supplied at the moment.
String	getFullName()	Returns the full name of the receiver.
Rat	getOwner()	Returns the actor the transmitter belongs to.
String	initTransmission()	Initializes the transmission.
void	input(Object obj)	The data to transmit.
boolean	isStopped()	Returns whether the transmitter has been stopped.
void	setOwner(Rat value)	Sets the actor the transmitter belongs to.
String	setUp()	Hook method for performing checks at setup time.
void	stopExecution()	Stops the execution.
String	transmit()	Performs the transmission.
void	variableChanged(adams.event.VariableChangeEvent e)	Gets triggered when a variable changed (added, modified, removed).

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

Method Detail

getFullName

String getFullName()

Returns the full name of the receiver.

Returns:

the name

setOwner

void setOwner(Rat value)

Sets the actor the transmitter belongs to.

Parameters:

value - the owner

getOwner

Rat getOwner()

Returns the actor the transmitter belongs to.

Returns:

the owner

setUp

String setUp()

Hook method for performing checks at setup time.

Returns:

null if successful, otherwise error message

accepts

Class[] accepts()

Returns the type of data that gets accepted.

Returns:

the type of data

initTransmission

String initTransmission()

Initializes the transmission.

Returns:

null if successfully initialized, otherwise error message

canInput

boolean canInput()

Whether input can be supplied at the moment.

Returns:

true if input is accepted

input

void input(Object obj)

The data to transmit.

Parameters:

obj - the data

transmit

String transmit()

Performs the transmission.

Returns:

null if successful, otherwise error message

stopExecution

void stopExecution()

Stops the execution.

Specified by:

stopExecution in interface adams.core.Stoppable

isStopped

boolean isStopped()

Returns whether the transmitter has been stopped.

Specified by:

isStopped in interface adams.core.StoppableWithFeedback

Returns:

true if stopped

variableChanged

void variableChanged(adams.event.VariableChangeEvent e)

Gets triggered when a variable changed (added, modified, removed).

Specified by:

variableChanged in interface adams.event.VariableChangeListener

Parameters:

e - the event