cz.cuni.amis.pogamut.usar2004.agent.module.master
Class MissionPackageModule

java.lang.Object
  cz.cuni.amis.pogamut.base.agent.module.AgentModule<AGENT>
      cz.cuni.amis.pogamut.base.agent.module.SensorModule<USAR2004Bot>
          cz.cuni.amis.pogamut.usar2004.agent.module.master.MissionPackageModule

All Implemented Interfaces:

cz.cuni.amis.pogamut.base.component.IComponent

public class MissionPackageModule
extends cz.cuni.amis.pogamut.base.agent.module.SensorModule<USAR2004Bot>

Master module for gathering every mission state message server sends. They are saved respectively by their name. There is a listener for MISSTA messages that updates data in local Map. All mastermodules are singletons.

Author:

vejmanm

Field Summary

protected cz.cuni.amis.pogamut.usar2004.agent.module.master.MissionPackageModule.MissionPackageMessageListener	packageListener
protected Map<String,MissionPackageState>	packageModule
protected static MissionPackageModule	singleton

Fields inherited from class cz.cuni.amis.pogamut.base.agent.module.SensorModule

worldView

Fields inherited from class cz.cuni.amis.pogamut.base.agent.module.AgentModule

agent, controller, eventBus, log

Constructor Summary

MissionPackageModule(USAR2004Bot bot)
Private ctor

Method Summary

protected void	cleanUp()
protected void	filePackageMessage(MissionPackageMessage message) Updates previous MissionPackageMessage or creates a new Record.
Set<String>	getAvailibleTypes() Returns list of availible mission state object types.
static MissionPackageModule	getModuleInstance(USAR2004Bot bot) Returns singleton instance of this module if it already exists.
MissionPackageState	getStatesByName(String name) Gets mission state message representative from local hashmap.
Boolean	isReady() Check method for making sure the acces to this module is possible.Returns false if either local map is empty or null;
protected boolean	updatePackageCollection(MissionPackageMessage message) Returns a flag that indicates if udatePackage was successful.

Methods inherited from class cz.cuni.amis.pogamut.base.agent.module.AgentModule

getComponentId, getLog, getState, initComponentId, isRunning, kill, pause, reset, resume, start, stop, toString

Methods inherited from class java.lang.Object

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

Field Detail

packageListener

protected cz.cuni.amis.pogamut.usar2004.agent.module.master.MissionPackageModule.MissionPackageMessageListener packageListener

singleton

protected static MissionPackageModule singleton

packageModule

protected Map<String,MissionPackageState> packageModule

Constructor Detail

MissionPackageModule

public MissionPackageModule(USAR2004Bot bot)

Private ctor

Parameters:

bot - USAR2004Bot variable for creating instance of each new record in stateModules(due to inheritance)

Method Detail

getModuleInstance

public static MissionPackageModule getModuleInstance(USAR2004Bot bot)

Returns singleton instance of this module if it already exists. If not it is created.

Parameters:

bot - Parameter for possible creating of new instance.

Returns:

Returns singleton instance of this module.

isReady

public Boolean isReady()

Check method for making sure the acces to this module is possible.Returns false if either local map is empty or null;

Returns:

Returns false if either local map is empty or null;

getStatesByName

public MissionPackageState getStatesByName(String name)

Gets mission state message representative from local hashmap. Returns null if none matches.

Parameters:

name - String representing the type of state to return

Returns:

Returns mission package State according to the name.

getAvailibleTypes

public Set<String> getAvailibleTypes()

Returns list of availible mission state object types.

Returns:

Returns list of availible mission state object types.

updatePackageCollection

protected boolean updatePackageCollection(MissionPackageMessage message)

Returns a flag that indicates if udatePackage was successful.

Parameters:

message - new MissionPackageMessage object.

Returns:

Return false if this message type with this name does not exist yet.

filePackageMessage

protected void filePackageMessage(MissionPackageMessage message)

Updates previous MissionPackageMessage or creates a new Record.

Parameters:

message - This ought to be MissionPackageMessage caught by listener.

cleanUp

protected void cleanUp()

Overrides:

cleanUp in class cz.cuni.amis.pogamut.base.agent.module.AgentModule<USAR2004Bot>