# All Classes and Interfaces

Class
Description
AbstractAgent
The super class of all MaDKit agents, v 5.
AbstractAgent.ReturnCode
This class enumerates all the return codes which could be obtained with essential methods of the `AbstractAgent` and `Agent` classes.
AbstractAgent.State
An agent state.
AbstractModel
Prototype class that will be used to encapsulate simulation models in a near future.
ACLMessage
This class describes an ACL message.
ActionInfo
This class encapsulates action information which could be used to easily create a new `MDKAbstractAction`.
Activator<A extends AbstractAgent>
This class defines a tool for scheduling mechanism.
ActMessage
This class describes a generic speech act message.
Agent
The super class of all MaDKit threaded agents, v 5.
AgentAction
Enum representing agent actions
AgentAddress
Identifies an agent within the artificial society.
AgentClassFilter
Filter to be used with `LaunchAgentsMenu` It tests if a class should be used
AgentFrame
The default frame which is used for the agents in the GUI engine of MaDKit.
AgentLifeEvent
A message which is sent to agents that have requested a hook on `HookMessage.AgentActionEvent.AGENT_STARTED` or `HookMessage.AgentActionEvent.AGENT_TERMINATED`
AgentLogger
This class defines a logger specialized for MaDKit agents.
AgentLogLevelMenu
An out of the box menu for manipulating the log level of an agent.
AgentMenu
An out of the box menu called Agent for MaDKit Agent GUI.
AgentStatusPanel
A panel that displays a flag if the MaDKit kernel is online.
BooleanAction
BooleanMessage
A message class that conveys a boolean value.
CGREvent
Root class of messages which are sent to agents that have requested hooks to the kernel
ClassPathSensitiveMenu
The super class of MaDKit menu which have to be update when the class path is changed or updated with new classes or files.
ConsoleAgent
This agent displays standard out and err prints in its GUI.
ConversationFilter
A filter that selects messages based on their conversation ID.
ConversationID
This class represents the conversation ID to which a message belongs.
DateBasedDiscreteEventActivator<A extends AbstractAgent>
A behavior activator that is designed to work with a `DateBasedDiscreteEventScheduler`, that is following a discrete-event simulation scheme.
DateBasedDiscreteEventScheduler
DefaultMaDKitRoles
Defines default roles used by the MaDKit kernel or regular agents to achieve specific CGR queries.
DiscreteEventAgentsActivator<A extends AbstractAgent>
An activator that works using a discrete-event simulation scheme.
DisplayMenu
Class for building the display menu of MDK frames.
EnumMessage<E extends Enum<E>>
This parameterizable class could be used to build a message tagged with an enumeration and conveying any java objects using an array of Object.
ErrorMessages
Gatekeeper
This interface is implemented by objects which are used to verify if an agent is allowed to play a certain role in a group.
GenericBehaviorActivator<A extends AbstractAgent>
An activator that invokes a single method with no parameters on a group of agents.
GlobalAction
Global actions that can be triggered from anywhere during execution.
GUIManagerAction
Enum representing operations which could be done by the default GUI manager of MaDKit.
GUIMessage
Message type that could be used to ask the gui manager to do something
HelpMenu
Class for building the help menu of MDK frames.
HookMessage
This message could be used to request a kernel's hook on agent actions so that the sender will be kept informed when an agent performed particular action.
HookMessage.AgentActionEvent
Enumeration representing agent actions that could be monitored using hooks.
I18nUtilities
Internationalization help class containing only static methods.
IntegerMessage
A message class that conveys an integer.
KernelAction
Enum representing kernel actions.
KernelAddress
This class represents a unique identifier for MaDKit kernel.
KernelException
Thrown to indicate that the agent is trying to use a method while not launched or already dead.
KernelMessage
The brand new version of KernelMessage.
KQMLMessage
This class describes a KQML message.
LaunchAgentsMenu
This class builds a `JMenu` containing all the agents which are on the class path, so that they can be individually launched.
LaunchMain
This class builds a `JMenu` containing all the agent classes containing a main method
LaunchMAS
This class builds a `JMenu` containing all the MAS which have been found on the class path, so that they can be individually launched according to their configuration.
LaunchMDKConfigurations
This class builds a `JMenu` containing all the MDK configuration files found on the class path.
LaunchXMLConfigurations
This class builds a `JMenu` containing all the MDK xml configuration files found on the class path.
LocalCommunity
Implements Constants which are used for the primary CGR organization places.
LocalCommunity.Groups
MDK kernel core groups.
LocalCommunity.Roles
MDK kernel core roles.
LoggingAction
Enum representing agent actions
Madkit
MaDKit 5 booter class.
Madkit.BooleanOption
Option used to activate or disable features on startup.
Madkit.LevelOption
MaDKit options valued with a string representing a `Level` value.
Madkit.Option
MaDKit options which are valued with a string representing parameters.
MadkitClassLoader
The MadkitClassLoader is the class loader used by MaDKit.
MadkitMenu
An out of the box menu for MaDKit applications
MadkitOption
Every regular MaDKit Options implements this interface.
MadkitProperties
The properties object used within MaDKit.
MadkitToolBar
An out of the box toolbar for MaDKit based applications.
MapMessage<K,V>
This class could be used to build message conveying `Map` objects between MaDKit agents.
MASModel
This represents a MaDKit session
MDKAbstractAction
This class provides an easy way of building new actions (`Action`) initialized with `ActionInfo` objects.
MDKDesktopFrame
A class that could be overridden to define a new desktop frame for MaDKit
Message
The generic MaDKit message class.
MessageEvent
A message which is sent to agents that have requested a hook on `HookMessage.AgentActionEvent.AGENT_STARTED` or `HookMessage.AgentActionEvent.AGENT_TERMINATED`
MessageFilter
Instances of classes that implement this interface are used to filter messages when consulting the mailbox.
NetworkCommunity
Defines the default groups and roles used for networking.
NetworkCommunity.Groups
Default groups in the Network community.
NetworkCommunity.Roles
Default roles in the Network community.
ObjectMessage<T>
This parameterizable class could be used to convey any Java Object between MaDKit agents.
Organization
Deprecated.
as of MaDKit 5.2 replaced by `DefaultMaDKitRoles`
OrganizationEvent
A message which is sent to agents that have requested a hook on `HookMessage.AgentActionEvent.CREATE_GROUP`, `HookMessage.AgentActionEvent.REQUEST_ROLE`, `HookMessage.AgentActionEvent.LEAVE_GROUP`, or `HookMessage.AgentActionEvent.LEAVE_ROLE`
OrganizationSnapshot
This class is just an alias for using the underlying data structure
OutputPanel
A scrollable panel that prints all the agent's logging activity.
PrintableFrame
Interface that adds the printing feature to MDK frames
Probe<A extends AbstractAgent>
This class defines a watcher's generic probe.
PropertyProbe<A extends AbstractAgent,T>
This probe inspects fields of type T on agents of type A and its subclasses.
Scheduler
Scheduler is the core agent for defining multi-agent based simulations.
Scheduler.SimulationState
A simulation state.
Scheduler.SimulationTime
SchedulingAction
Enum representing operations which could be done by a `Scheduler` agent.
SchedulingMessage
This message class could be used to interact with a Scheduler agent.
SenderRoleFilter
A filter that accepts message based on the sender's role.
SimulationException
This unchecked exception could be used by activators and probes to indicate and propagate the exception thrown by an agent during the use of an `Activator` or `Probe`.
SingleAgentProbe<A extends AbstractAgent,T>
This probe inspects fields of type T on only one agent of type A and its subclasses.
StringMessage
A message class that conveys a string.
SwingUtil
This class provides some utilities for building swing components.
SwingViewer
A very basic simulation viewer agent.
UIAction
Enum representing actions which could be used on MDK frames
Watcher
This class defines a generic watcher agent.
Words
Enum containing key for some useful words
XMLMessage
A message that carries an XML document.
XMLUtilities
XML shortcuts as static methods