sk.fiit.testframework.communication.agent

Class AgentJim

java.lang.Object

sk.fiit.testframework.communication.agent.AgentJim

public class AgentJim
extends Object

Represents a single agent instance that's connected to the test framework. It can be an agent launched locally by the test framework, or an externally launched agent that's connected to the test framework.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentJim.TeamSide Represents a side that the agent plays on.

Field Summary

Fields

Modifier and Type	Field and Description
private AgentData	agentData
private static Logger	logger
private StringBuilder	output Used for accumulating all of the agent's standard output text
private int	sceneGraphPlayer
private org.apache.commons.net.tftp.TFTPClient	tftpClient
private String	tftpIP
private int	tftpPort
private WorldModel	worldModel

Constructor Summary

Constructors

Constructor and Description
AgentJim(AgentData agentData, String tftpIP, int tftpPort) Constructor used when we want to attach to an running Jim agent connected to the server on address serverAddress.

Method Summary

Methods

Modifier and Type	Method and Description
void	connectToServer()
void	disconnectFromServer()
private void	executeRubyScript(String script) Invokes executing of ruby script on special TFTP server.
AgentData	getAgentData()
int	getSceneGraphPlayer()
StringBuilder	getStdout() Returns the string builder used for accumulating all of the agent's standard output text.
InetSocketAddress	getTFTPAddress()
String	getTftpIP()
int	getTftpPort()
WorldModel	getWorldModel()
void	invokeMove(String move)
void	invokePlanChange(String planName) Makes the agent change its planner.
void	invokeReplan() Makes the agent reload all its ruby scripts, which will cause a replan
void	invokeRestart() Deprecated.
void	invokeXMLReload() Makes the agent reload all its XML moves (doesn't reload annotations)
boolean	isConnectedToServer()
private void	sendFile(String saveFileAs, InputStream inputStream) Sends a file to remote TFTP server.
void	setSceneGraphPlayer(int sceneGraphPlayer)
void	setWorldModel(WorldModel model)
String	toString() Returns a string that is used as a unique identifier of the agent in the AgentManager class.

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static Logger logger

output

private StringBuilder output

Used for accumulating all of the agent's standard output text

sceneGraphPlayer

private int sceneGraphPlayer

worldModel

private WorldModel worldModel

agentData

private AgentData agentData

tftpClient

private org.apache.commons.net.tftp.TFTPClient tftpClient

tftpPort

private int tftpPort

tftpIP

private String tftpIP

Constructor Detail

AgentJim

public AgentJim(AgentData agentData,
        String tftpIP,
        int tftpPort)

Constructor used when we want to attach to an running Jim agent connected to the server on address serverAddress. This is especially useful when debugging, because we don't have to run new instance of agent everytime we want to use testcase. We can simply run agent in shell and by this constructor treat is like a regular runned agent.

Parameters:

agentData -

Method Detail

getStdout

public StringBuilder getStdout()

Returns the string builder used for accumulating all of the agent's standard output text. Only works for agents launched by the test framework.

getAgentData

public AgentData getAgentData()

getTftpPort

public int getTftpPort()

getTftpIP

public String getTftpIP()

getTFTPAddress

public InetSocketAddress getTFTPAddress()

isConnectedToServer

public boolean isConnectedToServer()

connectToServer

public void connectToServer()

disconnectFromServer

public void disconnectFromServer()

invokePlanChange

public void invokePlanChange(String planName)
                      throws IOException

Makes the agent change its planner. Also reloads all its ruby scripts, which will cause a replan.

Parameters:

planName - the class name of the new plan (NOT the ruby file name)

Throws:

IOException - on failed communication with the agent's TFTP server

invokeXMLReload

public void invokeXMLReload()
                     throws IOException

Makes the agent reload all its XML moves (doesn't reload annotations)

Throws:

IOException - on failed communication with the agent's TFTP server

invokeReplan

public void invokeReplan()
                  throws IOException

Makes the agent reload all its ruby scripts, which will cause a replan

Throws:

IOException - on failed communication with the agent's TFTP server

invokeRestart

@Deprecated
public void invokeRestart()
                   throws IOException

Deprecated.

Doesn't do anything.

CommunicationThread (a class in the agent that this method relies on) is deprecated, so I assume that this is as well.

Throws:

IOException

invokeMove

public void invokeMove(String move)
                throws IOException

Throws:

IOException

sendFile

private void sendFile(String saveFileAs,
            InputStream inputStream)
               throws IOException

Sends a file to remote TFTP server.

Parameters:

host - Remote TFTP server.

saveFileAs - Determines how file on remote TFTP server will be saved.

inputStream - Input stream of data.

Throws:

IOException

executeRubyScript

private void executeRubyScript(String script)
                        throws IOException

Invokes executing of ruby script on special TFTP server. Used for internal purposes with agent Jim.

Parameters:

script - UTF-8 String text to be executed on server side.

Throws:

IOException

toString

public String toString()

Returns a string that is used as a unique identifier of the agent in the AgentManager class. It consists of the agent's uniform number followed by its team name (no spaces)

Overrides:

toString in class Object

getSceneGraphPlayer

public int getSceneGraphPlayer()

setSceneGraphPlayer

public void setSceneGraphPlayer(int sceneGraphPlayer)

setWorldModel

public void setWorldModel(WorldModel model)

getWorldModel

public WorldModel getWorldModel()