gsim.core.objects
Interface ActionIF

All Superinterfaces:

java.io.Serializable

public interface ActionIF
extends java.io.Serializable

The ActionIF specifies actions of an agent. It abstracts from the fact whether the action is defined on the frame or instance level.

Author:

Stephan

Method Summary

void	addObjectClassParam(java.lang.String objectClassName) Adds a parameter to this action.
void	clearObjectClassParams() Removes all parameters.
java.lang.String	getActionClassName() Gets the actual java class that is called when this action becomes activated.
java.lang.String	getName() Gets the name of this action.
java.lang.String[]	getObjectClassParams() Gets the parameters of this action.
boolean	hasObjectParameter() Tests whether this action has parameters.
void	removeObjectClassParam(java.lang.String path) Remove a single parameter.
void	setActionClassName(java.lang.String className) Sets the actual java class that is called when this action becomes activated.
gsim.def.objects.Unit	toUnit() This method returns the underlying entity (Frame or Instance).

Method Detail

addObjectClassParam

void addObjectClassParam(java.lang.String objectClassName)
                         throws GSimObjectException

Adds a parameter to this action.

Parameters:

objectClassName - the type of object

Throws:

GSimObjectException

clearObjectClassParams

void clearObjectClassParams()
                            throws GSimObjectException

Removes all parameters.

Throws:

GSimObjectException

getActionClassName

java.lang.String getActionClassName()
                                    throws GSimObjectException

Gets the actual java class that is called when this action becomes activated.

Returns:

fully qualified name of the class

Throws:

GSimObjectException

getName

java.lang.String getName()
                         throws GSimObjectException

Gets the name of this action.

Returns:

the name

Throws:

GSimObjectException

getObjectClassParams

java.lang.String[] getObjectClassParams()
                                        throws GSimObjectException

Gets the parameters of this action.

Returns:

a list of paths to the respective object of the agent.

Throws:

GSimObjectException

hasObjectParameter

boolean hasObjectParameter()
                           throws GSimObjectException

Tests whether this action has parameters.

Returns:

true if at least one parameter is defined, false otherwise

Throws:

GSimObjectException

removeObjectClassParam

void removeObjectClassParam(java.lang.String path)
                            throws GSimObjectException

Remove a single parameter.

Parameters:

path - path to the parameter

Throws:

GSimObjectException

setActionClassName

void setActionClassName(java.lang.String className)
                        throws GSimObjectException

Sets the actual java class that is called when this action becomes activated.

Parameters:

className -

Throws:

GSimObjectException

toUnit

gsim.def.objects.Unit toUnit()

This method returns the underlying entity (Frame or Instance).

Returns:

unit