ABLE, Version 1.1b

com.ibm.able.agents
Interface AbleAgent

All Known Subinterfaces:
FipaAccAgent, FipaAgent, FipaAmsAgent, FipaDfAgent
All Known Implementing Classes:
AbleDefaultAgent

public abstract interface AbleAgent
extends AbleBean, AbleBeanContainer, AbleSensorManager, AbleEffectorManager

This interface defines an AbleAgent, an AbleBean container which can be composed of other AbleBeans.

Version:
$Revision: 1.3 $, $Date: 2000/02/21 20:00:56 $

Method Summary
 void addEventConnection(AbleEventConnection theConnection)
          Add an event connection.
 java.lang.String getAgentAddr()
          Retrieve the address of this agent.
 java.lang.String getAgentHost()
          Retrieve the name of the host on which this agent is running.
 java.lang.String getAgentName()
          Retrieve the current formal agent name of this agent.
 AbleDataSource getDataSource()
          Retrieve the current active DataSource (if any).
 long getNumEpochs()
          Get the number of training epochs.
 java.util.Vector getProcessList()
          Get the sequential processing list
 boolean isActiveDataSource()
          Tests whether this agent has an active data source.
 void removeEventConnection(AbleEventConnection theConnection)
          Remove an event connection.
 void setActiveDataSource(boolean theState)
          Set the flag indicating if there is an active data source.
 void setProcessList(java.util.Vector theProcessList)
          Set the sequential processing list
 
Methods inherited from interface com.ibm.able.AbleBean
addAbleEventListener, addDestBufferConnection, addPropertyChangeListener, addPropertyConnection, addSourceBufferConnection, dataChanged, flushAbleEventQueue, getAbleEventListeners, getAbleEventProcessingEnabled, getAbleEventQueueSize, getComment, getDestBufferConnections, getFileName, getInputBuffer, getInputBuffer, getInputBufferAsStringArray, getInputBufferContents, getLogger, getName, getOutputBuffer, getOutputBuffer, getOutputBufferAsStringArray, getOutputBufferContents, getParent, getPropertyConnectionManager, getSleepTime, getSourceBufferConnections, getState, hasInputBuffer, hasOutputBuffer, init, init, isChanged, isConnectable, isDataFlowEnabled, isTimerEventProcessingEnabled, notifyAbleEventListeners, process, processBufferConnections, propertyChange, quitAll, quitEnabledEventProcessing, removeAbleEventListener, removeAllBufferConnections, removeDestBufferConnection, removePropertyChangeListener, removePropertyConnection, removeSourceBufferConnection, reset, restartEnabledEventProcessing, restoreFromFile, restoreFromFile, resumeAll, resumeEnabledEventProcessing, saveToFile, saveToFile, setAbleEventProcessingEnabled, setChanged, setComment, setDataFlowEnabled, setFileName, setInputBuffer, setInputBuffer, setLogger, setName, setOutputBuffer, setOutputBuffer, setParent, setSleepTime, setState, setTimerEventProcessingEnabled, startEnabledEventProcessing, suspendAll, suspendEnabledEventProcessing
 
Methods inherited from interface com.ibm.able.AbleBeanContainer
addBean, containsBean, containsBean, getBean, getBeans, removeAllBeans, removeBean
 
Methods inherited from interface com.ibm.able.beans.AbleSensorManager
addSensor, getSensors, invokeSensor, removeSensor, setSensors
 
Methods inherited from interface com.ibm.able.beans.AbleEffectorManager
addEffector, getEffectors, invokeEffector, removeEffector, setEffectors
 
Methods inherited from interface com.ibm.able.AbleEventListener
handleAbleEvent
 
Methods inherited from interface com.ibm.able.AbleEventQueueProcessor
processAbleEvent, processNoEventProcessingEnabledSituation, processTimerEvent
 

Method Detail

getAgentName

public java.lang.String getAgentName()
                              throws java.rmi.RemoteException
Retrieve the current formal agent name of this agent.
Returns:
The "agent name" of this agent.

The agent name may be in the form of a simple name (the same as returned by getName() ), an RMI registry name, or an official FIPA name, depending on the environment in which the agent is used.

Throws:
java.rmi.RemoteException - On any error.

getAgentHost

public java.lang.String getAgentHost()
                              throws java.rmi.RemoteException
Retrieve the name of the host on which this agent is running.
Returns:
A String containing the name of the host on which this agent is running.
Throws:
java.rmi.RemoteException - On any error.

getAgentAddr

public java.lang.String getAgentAddr()
                              throws java.rmi.RemoteException
Retrieve the address of this agent.
Returns:
A String containing the address of this agent.
Throws:
java.rmi.RemoteException - On any error.

setActiveDataSource

public void setActiveDataSource(boolean theState)
                         throws java.rmi.RemoteException
Set the flag indicating if there is an active data source.
Parameters:
theState - Indicate whether there is an active data source in this agent


isActiveDataSource

public boolean isActiveDataSource()
                           throws java.rmi.RemoteException
Tests whether this agent has an active data source.
Returns:
true if agent contains an active data source; false otherwise.

getDataSource

public AbleDataSource getDataSource()
                             throws java.rmi.RemoteException
Retrieve the current active DataSource (if any).
Returns:
The current active data source

addEventConnection

public void addEventConnection(AbleEventConnection theConnection)
                        throws java.rmi.RemoteException
Add an event connection.
Parameters:
theConnection - An AbleEventConnection object


removeEventConnection

public void removeEventConnection(AbleEventConnection theConnection)
                           throws java.rmi.RemoteException
Remove an event connection.
Parameters:
theConnection - An AbleEventConnection object


setProcessList

public void setProcessList(java.util.Vector theProcessList)
                    throws java.rmi.RemoteException
Set the sequential processing list
Parameters:
theProcessList - The objects to be processed


getProcessList

public java.util.Vector getProcessList()
                                throws java.rmi.RemoteException
Get the sequential processing list
Returns:
Vector of beans to process (in order)

getNumEpochs

public long getNumEpochs()
                  throws java.rmi.RemoteException
Get the number of training epochs.
Returns:
the number of epochs

ABLE, Version 1.1b

ABLE: Produced by Joe, Don, and Jeff who say, 'Thanks for your support.'