marg.gui
Interface RobotModule

All Known Implementing Classes:
ModuleTabs

public interface RobotModule


Method Summary
 void addModulePlugin(ModulePlugin modPlugin)
          Adds a plugin to the module
 java.lang.String getModuleName()
          Gets the name of this module.
 java.awt.Color getModuleStatusColor()
          Gets the current status of the module as a Color object
 XMLClientHandler getXMLClientHandler()
          Get's the underlying XMLClientHandler used by the module.
 void removeModulePlugin(ModulePlugin modPlugin)
          Removes a plugin from the module
 void stopPlugins()
          Stops all plugins running on the module.
 

Method Detail

addModulePlugin

void addModulePlugin(ModulePlugin modPlugin)
Adds a plugin to the module

Parameters:
modPlugin - the plugin to be added

removeModulePlugin

void removeModulePlugin(ModulePlugin modPlugin)
Removes a plugin from the module

Parameters:
modPlugin - the plugin to be removed

getModuleName

java.lang.String getModuleName()
Gets the name of this module. Used on its button in the menu

Returns:
the name of this module

getModuleStatusColor

java.awt.Color getModuleStatusColor()
Gets the current status of the module as a Color object

Returns:
a Color object representing the module's status

getXMLClientHandler

XMLClientHandler getXMLClientHandler()
Get's the underlying XMLClientHandler used by the module. The handler is the one used by the module to communicate with an actual module on the robot.

Returns:
the underlying handler used by the module

stopPlugins

void stopPlugins()
Stops all plugins running on the module. Mainly used to do cleanup.