1 package cz.cuni.amis.pogamut.udk.agent.params;
2
3 import cz.cuni.amis.pogamut.base.agent.IAgentId;
4 import cz.cuni.amis.pogamut.base.agent.params.IAgentParameters;
5 import cz.cuni.amis.pogamut.base.agent.params.impl.RemoteAgentParameters;
6 import cz.cuni.amis.pogamut.base.agent.utils.runner.IAgentRunner;
7 import cz.cuni.amis.pogamut.base.agent.utils.runner.IMultipleAgentRunner;
8 import cz.cuni.amis.pogamut.base.communication.connection.IWorldConnectionAddress;
9 import cz.cuni.amis.pogamut.base.communication.connection.impl.socket.ISocketConnectionAddress;
10
11 /**
12 * Agent parameters are meant to provide run-time parameters needed by various UDK agents for
13 * running such as {@link IAgentId} and {@link ISocketConnectionAddress}.
14 * <p><p>
15 * If you need to populate the parameters after instantiation, use setters available in this
16 * class: {@link UDKAgentParameters#setAgentId(IAgentId)}, {@link UDKAgentParameters#setWorldAddress(IWorldConnectionAddress)}.
17 * <p><p>
18 * NOTE: all {@link IAgentParameters} implementors are usually used together with {@link IAgentRunner} or {@link IMultipleAgentRunner}
19 * which usually contains sensible default params, therefore there is no need to set all parameters
20 * into newly created ones as runners will supply them via {@link IAgentParameters#assignDefaults(IAgentParameters)}.
21 *
22 * @see RemoteAgentParameters
23 * @author Jimmy
24 */
25 public class UDKAgentParameters extends RemoteAgentParameters {
26
27 /**
28 * If you need to populate the parameters after instantiation, use setters available in this
29 * class: {@link UDKAgentParameters#setAgentId(IAgentId)}, {@link UDKAgentParameters#setWorldAddress(IWorldConnectionAddress)}.
30 */
31 public UDKAgentParameters() {
32 super();
33 }
34
35 @Override
36 public UDKAgentParameters setAgentId(IAgentId agentId) {
37 super.setAgentId(agentId);
38 return this;
39 }
40
41 @Override
42 public UDKAgentParameters setWorldAddress(IWorldConnectionAddress address) {
43 super.setWorldAddress(address);
44 return this;
45 }
46
47 }