org.simbrain.world.odorworld.effectors

Class Speech

java.lang.Object

org.simbrain.world.odorworld.effectors.Effector

org.simbrain.world.odorworld.effectors.Speech

public class Speech
extends Effector

Model simple speech behaviors. Each speech effector is associated with a specific phrase. To activate speech either manually activate or de-activate it or set the "value" to a number above a threshold (currently set to 0).

Author:

Jeff Yoshimi

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_PHRASE Default phrase.
static double	DEFAULT_THRESHOLD Default threshold.

Fields inherited from class org.simbrain.world.odorworld.effectors.Effector

parent

Constructor Summary

Constructors

Constructor and Description
Speech(OdorWorldEntity parent, java.lang.String phrase, double threshold) Construct the speech effector.

Method Summary

Modifier and Type	Method and Description
double	getAmount()
java.lang.String	getPhrase()
double	getThreshold()
java.lang.String	getTypeDescription() Short description of the effector type.
boolean	isActivated()
void	setActivated(boolean activated)
void	setAmount(double amount)
void	setPhrase(java.lang.String phrase)
void	setThreshold(double threshold)
void	update() Move the agent in a manner appropriate to the effector type.

Methods inherited from class org.simbrain.world.odorworld.effectors.Effector

getApplicableTypes, getId, getLabel, getParent, setId, setLabel

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PHRASE

public static final java.lang.String DEFAULT_PHRASE

Default phrase.

See Also:

Constant Field Values

DEFAULT_THRESHOLD

public static final double DEFAULT_THRESHOLD

Default threshold.

See Also:

Constant Field Values

Constructor Detail

Speech

public Speech(OdorWorldEntity parent,
              java.lang.String phrase,
              double threshold)

Construct the speech effector.

Parameters:

parent - parent entity

phrase - the phrase associated with this effector

threshold -

Method Detail

update

public void update()

Description copied from class: Effector

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

Specified by:

update in class Effector

getPhrase

public java.lang.String getPhrase()

Returns:

the phrase

setPhrase

public void setPhrase(java.lang.String phrase)

Parameters:

phrase - the phrase to set

isActivated

public boolean isActivated()

Returns:

the activated

setActivated

public void setActivated(boolean activated)

Parameters:

activated - the activated to set

getAmount

public double getAmount()

setAmount

public void setAmount(double amount)

Parameters:

amount - the amount to set

getThreshold

public double getThreshold()

Returns:

the threshold

setThreshold

public void setThreshold(double threshold)

Parameters:

threshold - the threshold to set

getTypeDescription

public java.lang.String getTypeDescription()

Description copied from class: Effector

Short description of the effector type.

Specified by:

getTypeDescription in class Effector

Returns:

the short description of the type