cz.cuni.amis.pogamut.ut2004.analyzer
Class UT2004AnalyzerObserverParameters

java.lang.Object
  cz.cuni.amis.pogamut.base.agent.params.impl.AgentParameters
      cz.cuni.amis.pogamut.base.agent.params.impl.RemoteAgentParameters
          cz.cuni.amis.pogamut.ut2004.agent.params.UT2004AgentParameters
              cz.cuni.amis.pogamut.ut2004.analyzer.UT2004AnalyzerObserverParameters

All Implemented Interfaces:

IAgentParameters, IRemoteAgentParameters

public class UT2004AnalyzerObserverParameters
extends UT2004AgentParameters

Constructor Summary

UT2004AnalyzerObserverParameters()

Method Summary

void	assignDefaults(IAgentParameters defaults) Fills missing parameters of 'this' with values from 'defaults'.
java.lang.String	getFileName() Returns file name that should be used for outputting data (just file name, must be combined with UT2004AnalyzerObserver.getOutputFilePath().
java.lang.String	getObservedAgentId() Returns ID of the player that should be observed.
java.lang.String	getOutputPath() Contains path to directory where the observer should output its results.
boolean	isWaitForMatchRestart() Whether the observer should wait for match-restart before it starts to collect data.
UT2004AnalyzerObserverParameters	setAgentId(IAgentId agentId) Sets agent id into the parameters.
UT2004AnalyzerObserverParameters	setFileName(java.lang.String fileName) Sets FileName to be used for the output.
UT2004AnalyzerObserverParameters	setObservedAgentId(java.lang.String observedAgentId) Sets 'id' (usually taken from the UnrealId that is present for instance in Self#getId()) of the bot that is going to be observed by newly created observer.
UT2004AnalyzerObserverParameters	setOutputPath(java.lang.String outputPath) Sets path to directory where the observer should output its results.
UT2004AnalyzerObserverParameters	setWaitForMatchRestart(boolean waitForMatchRestart) Sets whether the observer should wait for match-restart before it starts to collect data.
UT2004AnalyzerObserverParameters	setWorldAddress(IWorldConnectionAddress address) Sets connection address into the parameters.

Methods inherited from class cz.cuni.amis.pogamut.base.agent.params.impl.RemoteAgentParameters

getWorldAddress

Methods inherited from class cz.cuni.amis.pogamut.base.agent.params.impl.AgentParameters

getAgentId

Methods inherited from class java.lang.Object

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

Methods inherited from interface cz.cuni.amis.pogamut.base.agent.params.IAgentParameters

getAgentId

Constructor Detail

UT2004AnalyzerObserverParameters

public UT2004AnalyzerObserverParameters()

Method Detail

getObservedAgentId

public java.lang.String getObservedAgentId()

Returns ID of the player that should be observed.

Returns:

setObservedAgentId

public UT2004AnalyzerObserverParameters setObservedAgentId(java.lang.String observedAgentId)

Sets 'id' (usually taken from the UnrealId that is present for instance in Self#getId()) of the bot that is going to be observed by newly created observer.

WARNING: Note that you should not mess with 'setters' in different threads as they are non-thread-safe and may interrupt horrible agent instantiations with such behavior.

Parameters:

address -

Returns:

this instance

setAgentId

public UT2004AnalyzerObserverParameters setAgentId(IAgentId agentId)

Description copied from class: AgentParameters

Sets agent id into the parameters.

WARNING: Note that you should not mess with 'setters' in different threads as they are non-thread-safe and may interrupt horrible agent instantiations with such behavior.

Overrides:

setAgentId in class UT2004AgentParameters

Returns:

this instance

setWorldAddress

public UT2004AnalyzerObserverParameters setWorldAddress(IWorldConnectionAddress address)

Description copied from class: RemoteAgentParameters

Sets connection address into the parameters.

WARNING: Note that you should not mess with 'setters' in different threads as they are non-thread-safe and may interrupt horrible agent instantiations with such behavior.

Overrides:

setWorldAddress in class UT2004AgentParameters

Returns:

this instance

getOutputPath

public java.lang.String getOutputPath()

Contains path to directory where the observer should output its results. MUST POINT TO DIR!

Returns:

setOutputPath

public UT2004AnalyzerObserverParameters setOutputPath(java.lang.String outputPath)

Sets path to directory where the observer should output its results. MUST POINT TO DIR!

Parameters:

outputPath -

isWaitForMatchRestart

public boolean isWaitForMatchRestart()

Whether the observer should wait for match-restart before it starts to collect data.

Returns:

setWaitForMatchRestart

public UT2004AnalyzerObserverParameters setWaitForMatchRestart(boolean waitForMatchRestart)

Sets whether the observer should wait for match-restart before it starts to collect data.

Parameters:

waitForMatchRestart -

getFileName

public java.lang.String getFileName()

Returns file name that should be used for outputting data (just file name, must be combined with UT2004AnalyzerObserver.getOutputFilePath().

Returns:

setFileName

public UT2004AnalyzerObserverParameters setFileName(java.lang.String fileName)

Sets FileName to be used for the output. Must end with some file extension (e.g., .csv). (Just file name, will be combined with UT2004AnalyzerObserver.getOutputFilePath().

Parameters:

fileName -

assignDefaults

public void assignDefaults(IAgentParameters defaults)

Description copied from interface: IAgentParameters

Fills missing parameters of 'this' with values from 'defaults'.

This method is meant as a hook for IAgentRunners that can ease the burden of instantiating&launching the agent into a specific environment.

It assigns params from 'default' only to fields (of this) that are null!

Specified by:

assignDefaults in interface IAgentParameters

Overrides:

assignDefaults in class RemoteAgentParameters

Parameters:

defaults - values that should filled missing parameters