org.commonreality.efferent
Interface IEfferentCommandTemplate<E extends IEfferentCommand>

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
AbstractEfferentCommandTemplate, MovementCommandTemplate, PressCommandTemplate, ReleaseCommandTemplate, RotateCommandTemplate, TranslateCommandTemplate, VocalizationCommandTemplate

public interface IEfferentCommandTemplate<E extends IEfferentCommand>
extends java.io.Serializable


Method Summary
 java.lang.String getDescription()
           
 java.lang.String getName()
          the name of the command
 E instantiate(IAgent agent, IEfferentObject object)
          instantiate this template using the supplied object
 boolean isConsistent(IEfferentCommand command)
          returns true if this IEfferentCommand is consistent with those created by this template.
 

Method Detail

getName

java.lang.String getName()
the name of the command

Returns:

getDescription

java.lang.String getDescription()
Returns:

instantiate

E instantiate(IAgent agent,
              IEfferentObject object)
                                       throws java.lang.Exception
instantiate this template using the supplied object

Returns:
Throws:
java.lang.Exception

isConsistent

boolean isConsistent(IEfferentCommand command)
returns true if this IEfferentCommand is consistent with those created by this template. This is used on the sensor side to make sure that the IEfferentCommand supplied is acting upon an IEfferentObject that can be acted upon

Parameters:
command -
Returns: