Editing revision 1 of FloodGrapher/Design

Robo Home | Changes | Preferences | AllPages

Editing old revision 1. Saving this page will replace the latest revision with this text.

package kawigi.tools;

=== Grapher back-end ===

* <tt>class Scheme</tt> : Aggregate of <tt>GrapherSegmentation</tt>s
:<tt>public GrapherSegmentation segmentAt(int index)</tt>
:<tt>public int size()</tt>
:<tt>public void add(GrapherSegmentation seg)</tt>

* <tt>class SegmentedData</tt> : A sort of database using the <tt>Scheme</tt> that can be "selected" from to collect actual data.  It should be flexible enough that it should be unnecessary to subclass it.  This class should be easily createable from the information saved by the Graphing bot, and may also have a constructor to take the array of data and scheme, so that it can be extended to analyze data from other bots.
:<tt>private Scheme scheme</tt>
:<tt>private Object statsbuffer</tt> : a multi-dimensional array of numbers whose dimensionality is one more than the size of the scheme.  Shouldn't be jagged (so a finite number of buckets can be used to take any cross-section of the data).
:<tt>public SegmentedData(Scheme scheme, Object stats)</tt> : Creates a new <tt>SegmentedData</tt> object.  <tt>stats</tt> should be a non-jagged multi-dimensional array of doubles, the size of the scheme should be one less than the dimensionality of the stats (if not, expect crashes later).
:<tt>public void createSelectionGUI(GraphControlWindow window)</tt> : Sets up the <tt>GraphControlWindow</tt> to have all the necessary widgets to select a graph.  The components added to this window will come from the <tt>GrapherSegmentation</tt> objects in the Scheme.  The window is also an <tt>ActionListener</tt> and <tt>ItemListener</tt> and should be added as a listener to the relevant components.
:<tt>public GraphData getSelectedGraphData()</tt> : This is the main point of this class, to get the data selected through the various GUI components.
:<tt>public void setData(SegmentedData reload)</tt> : sets the data in this object to the data in <tt>reload</tt>.  This is used to "refresh" the graph and keep the same UI.

* <tt>interface GrapherSegmentation</tt> : represents a <tt>SegmentationAxis</tt>.
:<tt>public String getName()</tt> : gets the name of this segmentation axis
:<tt>public void addSelectionWidget(GraphControlWindow window)</tt> : adds a component (most often a <tt>JComboBox</tt>) to select information from this segmentation, as well as necessary listeners, to the window.  The object should keep a reference to this component and only one such widget should ever be associated with each <tt>GrapherSegmentation</tt> object.
:<tt>public boolean accept(int index)</tt> : returns true if the current state of the widget accepts this segment index.  Returns false if it does not or if the widget has not yet been created.
** Some possible subclasses: <tt>DistanceGSegmentation</tt>, <tt>BFTGSegmentation</tt>, <tt>LateralVelocityGSegmentation</tt>, <tt>AccelerationGSegmentation</tt>, <tt>WallGSegmentation</tt>

* <tt>class GraphData</tt>: contains the array of values to be graphed for a single line graph, and the intended color, which can occasionally be changed.
:<tt>public GraphData(Color c, double[] data)</tt>
:<tt>public GraphData(double[] data)</tt>
:<tt>public Color getColor()</tt>
:<tt>public void setColor(Color newcolor)</tt>
:<tt>public double[] getData()</tt>

*<tt>interface FileFormat</tt>: Represents the format a robot's data file is saved in.  ''Implementations should have an empty constructor.''
:<tt>public SegmentedData getData(File datafile) throws IOException, InvalidFileException</tt>
:<tt>public String getFormatName()</tt> : Used when the object is dynamically loaded with other FileFormat objects to create a list of possible objects to use on a given file.
* Possible Subclasses: <tt>FloodGrapherFileFormat</tt>, <tt>FloodMini14FileFormat</tt>, <tt>Fhqwhgads11FileFormat</tt>, <tt>JekylFileFormat</tt>

* <tt>class InvalidFileException extends Exception</tt> : Thrown when the wrong <tt>FileFormat</tt> is used to read a certain file.
:<tt>public InvalidFileException(String message)</tt>

----

=== Grapher front-end ===

* <tt>class GraphColorSelector</tt>: A simple widget with a spectrum of saturated, bright colors to choose from.  
	Color getSelectedColor()

* <tt>class GraphDisplay extends JPanel</tt>: A widget that shows a series of <tt>GraphData</tt> objects in their respective colors.  Only one graph will be kept for each <tt>GraphControlWindow</tt> to create the graphs.
:<tt>public void addGraph(GraphData graph, GraphControlWindow source)</tt> : adds the new graph or replaces the old one from this source if one exists
:<tt>public void removeGraph(GraphControlWindow source)</tt> : removes the graph associated with the given frame from the display.  Called when the <tt>GraphControlWindow</tt> is closed.
** This class may have more options like smoothing or something.

* <tt>GraphControlWindow extends JInternalFrame implements ItemListener, ActionListener, InternalFrameListener</tt>
:<tt>public GraphControlWindow(SegmentedData data, String name, GraphDisplayer )</tt> : the name is set on the title bar of the window, the GUI components are added to it for the segmentation of the graph as well as a <tt>GraphColorSelector</tt> and a refresh button.
:<tt>public void actionPerformed(ActionEvent event)</tt> : for interface <tt>ActionListener</tt>.  Updates the <tt>GraphDisplayer</tt>.
:<tt>public void itemStateChanged(ItemEvent event)</tt> : for interface <tt>ItemListener</tt>.  Updates the <tt>GraphDisplayer</tt>
:<tt>public void internalFrameClosing(InternalFrameEvent event)</tt> : disposes of the window after removing the graph associated with this window from the <tt>GraphDisplay</tt>
:<tt>public void internalFrameDidWhatever(InternalFrameEvent event)</tt> : whatever else is necessary to satisfy interface <tt>InternalFrameListener</tt>, these probably won't do anything exciting.

* <tt>NewGraphWindow extends JDialog</tt> : includes components to choose a file and a <tt>FileFormat</tt> to use to open it and OK/Cancel buttons, has some sort of callback mechanism to add a <tt>GraphControlWindow</tt> back into the main GUI when the OK button is pressed.  The <tt>JDesktopPane</tt> will probably be passed into the constructor or something.

* <tt>FloodGrapherGUI extends JFrame</tt> : This is the container for the entire Graphing utility.  It contains mainly a <tt>GraphDisplayer</tt>, a <tt>JDesktopPane</tt>, and a <tt>JMenuBar</tt>.  The menus have the ability to open files and select from available <tt>FileFormat</tt> objects, close the application, and possibly some other features with the display.  The <tt>JDesktopPane</tt> will contain some number of <tt>GraphControlWindow</tt> which will control the <tt>GraphDisplayer</tt>.

----

=== Robot Design ===

* <tt>FloodGrapher extends AdvancedRobot</tt> : robot that creates and uses the configured modules.  If robots are allowed to do so, it should try to dynamically load these classes based on what it reads from a config file:
** Config file info:
*** <tt>Movement</tt> class
*** <tt>PowerManagement</tt> class
*** <tt>Segmentation</tt> classes (comma seperated?)
*** Distancing algorithm (dynamic | min=xxx,max=yyy | uncontrolled)
*** Wave Timing (scan | fire)
*** Number of Guess Factors (default 31?)

* <tt>class WaveBullet</tt> - pretty self-explanitory.  Includes a "segment" (array of numbers) to return to, has an update/check method, probably like <tt>MiniBullet</tt> but more clear.

* <tt>interface Movement</tt> : Represents a movement strategy.  These should be easily dynamically loadable, i.e. - have a parameterless constructor.
:<tt>public void onEvent(Event, AdvancedRobot)</tt>
:<tt>public void run(AdvancedRobot)</tt> : called in the run loop of the robot
** Subclasses: <tt>StationaryMovement</tt> : for TC-type tests, sort of an oxymoron, <tt>FloodMovement</tt>: Like FloodMini, <tt>FhqwhgadsMovement</tt>: Like Fhqwhgads, <tt>CigaretMovement</tt>: Like Cigaret, <tt>LinebackerMovement</tt>: Tries to corner you.  Good to test against.

* <tt>interface PowerManagement</tt> : Used to play with power management.  These should be easily dynamically loadable, i.e. - have a parameterless constructor.
:<tt>public double getPower(ScannedRobotEvent e, AdvancedRobot ar)</tt> : returns the power that should be used, or return <= 0 if no shot should be fired.
* * Subclasses: <tt>Power3Only</tt> : Useful, also used for TC stuff
<tt>FloodMiniPower</tt> : The energy management I use in most of my bots, <tt>FloodHTPower</tt> : A little more complex and strategy oriented power management, <tt>ConservativePower</tt> : A power management scheme that favors lower powers than 3 most of the time, <tt>RandomPower</tt> : Might be worthwhile, <tt>SparkPower</tt> : Might also be interesting, <tt>LowPower</tt> : Shoots fast bullets

* <tt>interface Segmentation</tt>: Robot's version of <tt>GrapherSegmentation</tt>.
:<tt>public int numSegments()</tt> : returns the total number of possible segments that could be chosen
:<tt>public GraphingSegmentation getGraphingSegmentation()</tt> : This information will probably be stored in the data files, the idea is to convert it directly into a <tt>GraphingSegmentation</tt> object.  There should basically be a corresponding <tt>GraphingSegmentation</tt> class for each <tt>Segmentation</tt> class.
:<tt>public int getSegmentIndex(ScannedRobotEvent e, AdvancedRobot ar, PowerManagement em)</tt> : Gets the index of the segment that should be used in the given situation.
** Subclasses (possibilities are endless): <tt>DistanceSegmentation</tt>, <tt>BFTSegmentation</tt>, <tt>LateralVelocitySegmentation</tt>, <tt>AccelerationSegmentation</tt>, <tt>WallSegmentation</tt>, <tt>TimeSegmentation</tt>, <tt>LateralDirectionSegmentation</tt>, <tt>MeleeSegmentation</tt>, (Be creative)

Summary:
Consciousness check: 3 + 10 =
This change is a minor edit. Send email notification that FloodGrapher/Design has been changed.
(Visit Preferences to set your user name.)

View other revisions
Robo Home | FloodGrapher | Changes | Preferences | AllPages