turtlekit.viewer

Class AbstractGridViewer

java.lang.Object

madkit.kernel.AbstractAgent

madkit.kernel.Watcher

madkit.simulation.viewer.SwingViewer

turtlekit.viewer.AbstractGridViewer

All Implemented Interfaces:

Comparable<AbstractAgent>

Direct Known Subclasses:

TKDefaultViewer

public abstract class AbstractGridViewer
extends SwingViewer

A viewer that probes the patch grid and displays a representation for it. It provides a zoom feature.

Since:

TurtleKit 3.0.0.4

Version:

0.1

Author:

Fabien Michel

Nested Class Summary

Nested classes/interfaces inherited from class madkit.kernel.AbstractAgent

AbstractAgent.ReturnCode, AbstractAgent.State

Field Summary

Fields

Modifier and Type	Field and Description
protected int	cellSize

Fields inherited from class madkit.kernel.AbstractAgent

logger

Constructor Summary

Constructors

Constructor and Description
AbstractGridViewer()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	activate()
protected void	end()
protected static void	executeThisViewer(String... args) This offers a convenient way to create a main method that launches a simulation using the viewer class under development.
int	getCellSize()
String	getCommunity() shortcut for getMadkitProperty(TurtleKit.Option.community)
TKEnvironment	getCurrentEnvironment()
int	getHeight()
Patch	getPatch(int x, int y)
Patch[]	getPatchGrid()
double	getSimulationTime()
int	getWidth()
protected void	initProbes()
void	setCellSize(int cellSize)
void	setupFrame(JFrame frame)

Methods inherited from class madkit.simulation.viewer.SwingViewer

getDisplayMenu, getDisplayPane, getFrame, getSynchroPaintingAction, getToolBar, isRendering, isSynchronousPainting, observe, render, setDisplayPane, setRendering, setRenderingInterval, setSynchronousPainting

Methods inherited from class madkit.kernel.Watcher

addProbe, allProbes, getProbes, removeAllProbes, removeProbe, toString

Methods inherited from class madkit.kernel.AbstractAgent

broadcastMessage, broadcastMessageWithRole, bucketModeCreateGroup, bucketModeRequestRole, checkAgentAddress, compareTo, createGroup, createGroup, createGroup, createGroupIfAbsent, createGroupIfAbsent, createGroupIfAbsent, createGUIOnStartUp, destroyCommunity, destroyGroup, destroyRole, executeThisAgent, executeThisAgent, executeThisAgent, getAgentAddressIn, getAgentsWithRole, getAgentsWithRole, getAgentWithRole, getDistantAgentWithRole, getExistingCommunities, getExistingGroups, getExistingRoles, getKernelAddress, getLogger, getMadkitConfig, getMadkitProperty, getMadkitProperty, getMyGroups, getMyRoles, getName, getNetworkID, getOrganizationSnapShot, getReplyTo, getServerInfo, getSimpleNetworkID, getState, hasGUI, hashCode, hasRole, isAlive, isCommunity, isGroup, isKernelOnline, isMadkitPropertyTrue, isMessageBoxEmpty, isRole, killAgent, killAgent, launchAgent, launchAgent, launchAgent, launchAgent, launchAgent, launchAgent, launchAgent, launchAgent, launchAgentBucket, launchAgentBucket, launchAgentBucket, launchAgentBucket, launchNode, launchXmlAgents, leaveGroup, leaveRole, nextMessage, nextMessage, nextMessages, proceedEnumMessage, purgeMailbox, receiveMessage, reload, requestRole, requestRole, sendMessage, sendMessage, sendMessageWithRole, sendMessageWithRole, sendReply, sendReplyWithRole, setLogLevel, setMadkitProperty, setMadkitProperty, setName

Methods inherited from class java.lang.Object

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

Field Detail

cellSize

protected int cellSize

Constructor Detail

AbstractGridViewer

public AbstractGridViewer()

Method Detail

initProbes

protected void initProbes()

activate

protected void activate()

Overrides:

activate in class Watcher

end

protected void end()

Overrides:

end in class AbstractAgent

setupFrame

public void setupFrame(JFrame frame)

Overrides:

setupFrame in class SwingViewer

getPatchGrid

public Patch[] getPatchGrid()

Returns:

getPatch

public Patch getPatch(int x,
             int y)

getHeight

public int getHeight()

Returns:

getWidth

public int getWidth()

Returns:

getCurrentEnvironment

public TKEnvironment getCurrentEnvironment()

getSimulationTime

public double getSimulationTime()

getCellSize

public int getCellSize()

Returns:

the cellSize

setCellSize

public void setCellSize(int cellSize)

Parameters:

cellSize - the cellSize to set

getCommunity

public final String getCommunity()

shortcut for getMadkitProperty(TurtleKit.Option.community)

Returns:

the community of the simulation this agent is in

executeThisViewer

protected static void executeThisViewer(String... args)

This offers a convenient way to create a main method that launches a simulation using the viewer class under development. This call only works in the main method of the viewer.

Parameters:

args - MaDKit or TurtleKit options

Since:

TurtleKit 3.0.0.1

See Also:

AbstractAgent.executeThisAgent(int, boolean, String...)