org.simbrain.world.odorworld.effectors

Class Effector

java.lang.Object

org.simbrain.world.odorworld.effectors.Effector

Direct Known Subclasses:

Speech, StraightMovement, Turning

public abstract class Effector
extends java.lang.Object

Abstract class for Odor World effectors.

Field Summary

Fields

Modifier and Type	Field and Description
protected OdorWorldEntity	parent Reference to parent entity.

Constructor Summary

Constructors

Constructor and Description
Effector(OdorWorldEntity parent, java.lang.String label) Construct the effector.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Class<?>>	getApplicableTypes() Return a list of entity types which can use this type of sensor.
java.lang.String	getId()
java.lang.String	getLabel()
OdorWorldEntity	getParent()
abstract java.lang.String	getTypeDescription() Short description of the effector type.
void	setId(java.lang.String name)
void	setLabel(java.lang.String label)
abstract void	update() Move the agent in a manner appropriate to the effector type.

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected OdorWorldEntity parent

Reference to parent entity.

Constructor Detail

Effector

public Effector(OdorWorldEntity parent,
                java.lang.String label)

Construct the effector.

Parameters:

parent - the parent entity

label - a label for this effector

Method Detail

update

public abstract void update()

Move the agent in a manner appropriate to the effector type.

getTypeDescription

public abstract java.lang.String getTypeDescription()

Short description of the effector type.

Returns:

the short description of the type

getApplicableTypes

public java.util.List<java.lang.Class<?>> getApplicableTypes()

Return a list of entity types which can use this type of sensor.

Returns:

list of applicable types.

getParent

public OdorWorldEntity getParent()

Returns:

the parent

getId

public java.lang.String getId()

Returns:

the name

setId

public void setId(java.lang.String name)

Parameters:

name - the name to set

getLabel

public java.lang.String getLabel()

Returns:

the label

setLabel

public void setLabel(java.lang.String label)

Parameters:

label - the label to set