cz.cuni.amis.pogamut.usar2004.utils

Class USAR2004BotRunner<BOT extends USAR2004Bot,PARAMS extends USAR2004AgentParameters>

java.lang.Object

cz.cuni.amis.pogamut.base.agent.utils.runner.impl.AgentRunner<BOT,PARAMS>

cz.cuni.amis.pogamut.usar2004.utils.USAR2004BotRunner<BOT,PARAMS>

Type Parameters:

BOT -

PARAMS -

All Implemented Interfaces:

cz.cuni.amis.pogamut.base.agent.utils.runner.IAgentRunner<BOT,PARAMS>

public class USAR2004BotRunner<BOT extends USAR2004Bot,PARAMS extends USAR2004AgentParameters>
extends cz.cuni.amis.pogamut.base.agent.utils.runner.impl.AgentRunner<BOT,PARAMS>

Class used for creating, connecting and starting servers with default settings that are taken from the properties.

The address where the instances will connect are defined either in the constructor or taken from the properties of the PogamutPlatform.

For more information about the class see AgentRunner.

Author:

ik, Jimmy

Field Summary

Fields

Modifier and Type	Field and Description
protected String	host Default host where the instances are going to be connected as defaults, see IAgentParameters.assignDefaults(IAgentParameters).
protected String	name Default name that will serve as a basis for IAgentId, see IAgentParameters.assignDefaults(IAgentParameters).
protected int	port Default port where the instances are going to be connected as defaults, see IAgentParameters.assignDefaults(IAgentParameters).

Fields inherited from class cz.cuni.amis.pogamut.base.agent.utils.runner.impl.AgentRunner

agents, consoleLogging, defaultLogLevel, factory, killed, killingAgents, killingAgentsMutex, latch, listener, log, main, mutex

Constructor Summary

Constructors

Constructor and Description
USAR2004BotRunner(Class<? extends IUSAR2004BotController> botControllerClass, String name, String host, int port) Construct the runner + specify all defaults.
USAR2004BotRunner(cz.cuni.amis.pogamut.base.factory.IAgentFactory<BOT,PARAMS> factory, String name, String host, int port) Construct the runner + specify all defaults.
USAR2004BotRunner(USAR2004BotModule module, String name, String host, int port) Construct the runner + specify all defaults.

Method Summary

Methods

Modifier and Type	Method and Description
String	getHost() Returns host, where newly launched bots will be connected to.
String	getName() Returns name that is going to be used to form new IAgentId of the bots.
int	getPort() Returns port, where newly launched bots will be connected to.
protected cz.cuni.amis.pogamut.base.agent.params.IAgentParameters	newDefaultAgentParameters() Provides default parameters that is, IAgentId using name and SocketConnectionAddress using host and port.
USAR2004BotRunner<BOT,PARAMS>	setHost(String host) Sets host, where newly launched bots will be connected to.
USAR2004BotRunner<BOT,PARAMS>	setName(String name) Sets name that is going to be used to form new IAgentId of the bots.
USAR2004BotRunner<BOT,PARAMS>	setPort(int port) Sets port, where newly launched bots will be connected to.
BOT	startAgent() Construct the runner without specifying anything as default.
List<BOT>	startAgents(int count)
List<BOT>	startAgents(PARAMS... agentParameters)

Methods inherited from class cz.cuni.amis.pogamut.base.agent.utils.runner.impl.AgentRunner

createAgentWithParams, fillInDefaults, fillInDefaults, getLog, isMain, isPausing, killAgent, killAgents, newAgentId, postStartedHook, postStartHook, preInitHook, preResumeHook, preStartHook, setConsoleLogging, setLog, setLogLevel, setMain, setPausing, startAgent, startAgentWithParams, startAgentWithParamsMain

Methods inherited from class java.lang.Object

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

Field Detail

host

protected String host

Default host where the instances are going to be connected as defaults, see IAgentParameters.assignDefaults(IAgentParameters).

port

protected int port

Default port where the instances are going to be connected as defaults, see IAgentParameters.assignDefaults(IAgentParameters).

name

protected String name

Default name that will serve as a basis for IAgentId, see IAgentParameters.assignDefaults(IAgentParameters).

Constructor Detail

USAR2004BotRunner

public USAR2004BotRunner(cz.cuni.amis.pogamut.base.factory.IAgentFactory<BOT,PARAMS> factory,
                 String name,
                 String host,
                 int port)

Construct the runner + specify all defaults.

Parameters:

factory - to be used for creating new IUSAR2004Bot instances

name - default name that serve as a basis for IAgentId

host - default host where the instances are going to be connected

port - default port where the instances are going to be connected

USAR2004BotRunner

public USAR2004BotRunner(USAR2004BotModule module,
                 String name,
                 String host,
                 int port)

Construct the runner + specify all defaults.

Parameters:

module - Guice module that is going to be used by the USAR2004BotFactory

name - default name that serve as a basis for IAgentId

host - default host where the instances are going to be connected

port - default port where the instances are going to be connected

USAR2004BotRunner

public USAR2004BotRunner(Class<? extends IUSAR2004BotController> botControllerClass,
                 String name,
                 String host,
                 int port)

Construct the runner + specify all defaults.

Parameters:

botControllerClass - controller that will be used to instantiate USAR2004BotModule, i.e., it will control the USAR2004Bot instance

name - default name that serve as a basis for IAgentId

host - default host where the instances are going to be connected

port - default port where the instances are going to be connected

Method Detail

startAgent

public BOT startAgent()
                                   throws cz.cuni.amis.utils.exception.PogamutException

Construct the runner without specifying anything as default. Default name for bots will be "USAR2004Bot" and host:port will be taken from the Pogamut platform properties.

Specified by:

startAgent in interface cz.cuni.amis.pogamut.base.agent.utils.runner.IAgentRunner<BOT extends USAR2004Bot,PARAMS extends USAR2004AgentParameters>

Overrides:

startAgent in class cz.cuni.amis.pogamut.base.agent.utils.runner.impl.AgentRunner<BOT extends USAR2004Bot,PARAMS extends USAR2004AgentParameters>

Parameters:

botControllerClass - controller that will be used to instantiate USAR2004BotModule, i.e., it will control the USAR2004Bot instance

Throws:

cz.cuni.amis.utils.exception.PogamutException

startAgents

public List<BOT> startAgents(int count)
                                          throws cz.cuni.amis.utils.exception.PogamutException

Specified by:

startAgents in interface cz.cuni.amis.pogamut.base.agent.utils.runner.IAgentRunner<BOT extends USAR2004Bot,PARAMS extends USAR2004AgentParameters>

Overrides:

startAgents in class cz.cuni.amis.pogamut.base.agent.utils.runner.impl.AgentRunner<BOT extends USAR2004Bot,PARAMS extends USAR2004AgentParameters>

Throws:

cz.cuni.amis.utils.exception.PogamutException

startAgents

public List<BOT> startAgents(PARAMS... agentParameters)
                                          throws cz.cuni.amis.utils.exception.PogamutException

Specified by:

startAgents in interface cz.cuni.amis.pogamut.base.agent.utils.runner.IAgentRunner<BOT extends USAR2004Bot,PARAMS extends USAR2004AgentParameters>

Overrides:

startAgents in class cz.cuni.amis.pogamut.base.agent.utils.runner.impl.AgentRunner<BOT extends USAR2004Bot,PARAMS extends USAR2004AgentParameters>

Throws:

cz.cuni.amis.utils.exception.PogamutException

getName

public String getName()

Returns name that is going to be used to form new IAgentId of the bots.

Returns:

name used for the newly started bots

setName

public USAR2004BotRunner<BOT,PARAMS> setName(String name)

Sets name that is going to be used to form new IAgentId of the bots.

If null is passed, generic "USAR2004Bot" will be set.

Parameters:

name - name used for the newly started bots

Returns:

this instance

getHost

public String getHost()

Returns host, where newly launched bots will be connected to.

Returns:

host running GB2004 server

setHost

public USAR2004BotRunner<BOT,PARAMS> setHost(String host)

Sets host, where newly launched bots will be connected to.

Parameters:

host - host running GB2004 server (can't be null)

Returns:

this instance

getPort

public int getPort()

Returns port, where newly launched bots will be connected to.

Returns:

port at the host where GB2004 server is listening for bot connections

setPort

public USAR2004BotRunner<BOT,PARAMS> setPort(int port)

Sets port, where newly launched bots will be connected to.

Parameters:

port - at the host where GB2004 server is listening for bot connections

Returns:

this instance

newDefaultAgentParameters

protected cz.cuni.amis.pogamut.base.agent.params.IAgentParameters newDefaultAgentParameters()

Provides default parameters that is, IAgentId using name and SocketConnectionAddress using host and port.

Specified by:

newDefaultAgentParameters in class cz.cuni.amis.pogamut.base.agent.utils.runner.impl.AgentRunner<BOT extends USAR2004Bot,PARAMS extends USAR2004AgentParameters>