org.botlibre.avatar

Class BasicAvatar

java.lang.Object

org.botlibre.avatar.BasicAvatar

All Implemented Interfaces:

Avatar

Direct Known Subclasses:

ImageAvatar

public class BasicAvatar
extends java.lang.Object
implements Avatar

Controls and manages the thought processing.

Property Summary

Type	Property and Description
java.lang.Long	clearAvatar

Constructor Summary

Constructors

Constructor and Description
BasicAvatar()

Method Summary

Modifier and Type	Method and Description
void	awake()
java.lang.Long	clearAvatarProperty()
void	emote(EmotionalState state, Network memory) Output the emotional state to the Avatar.
void	evaluateOutput(Vertex output) Evaluate the output for emotional expression.
void	evaluateResponse(Vertex output, Vertex response, Vertex meta, java.util.Map<Vertex,Vertex> variables, Network network) Evaluate the input response for actions and poses.
java.lang.String	getAction()
Bot	getBot() Return Bot.
java.lang.String	getCommand()
BinaryData	getCurrentImage()
java.lang.String	getEmote()
java.lang.String	getPose()
Primitive	getPrimitive()
void	initialize(java.util.Map<java.lang.String,java.lang.Object> properties) Initialize any configurable settings from the properties.
void	log(java.lang.String message, java.util.logging.Level level, java.lang.Object... arguments) Log the message if the debug level is greater or equal to the level.
void	log(java.lang.Throwable exception) Log the exception.
void	pool()
void	reset()
void	setAction(java.lang.String action)
Vertex	setAction(Vertex source, Vertex action) Self API to set avatar action.
void	setBot(Bot bot) Set Bot.
void	setCommand(java.lang.String command)
Vertex	setCommand(Vertex source, Vertex command) Self API to set avatar command.
void	setEmote(java.lang.String emote)
void	setPose(java.lang.String pose)
Vertex	setPose(Vertex source, Vertex pose) Self API to set avatar pose.
void	shutdown()
java.lang.String	toString() Print a useful string representation of the avatar.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

clearAvatar

public java.lang.Long clearAvatarProperty

Constructor Detail

BasicAvatar

public BasicAvatar()

Method Detail

pool

public void pool()

Specified by:

pool in interface Avatar

reset

public void reset()

Specified by:

reset in interface Avatar

getCommand

public java.lang.String getCommand()

Specified by:

getCommand in interface Avatar

setCommand

public void setCommand(java.lang.String command)

Specified by:

setCommand in interface Avatar

getAction

public java.lang.String getAction()

Specified by:

getAction in interface Avatar

setAction

public void setAction(java.lang.String action)

Specified by:

setAction in interface Avatar

getPose

public java.lang.String getPose()

Specified by:

getPose in interface Avatar

setPose

public void setPose(java.lang.String pose)

Specified by:

setPose in interface Avatar

getEmote

public java.lang.String getEmote()

Specified by:

getEmote in interface Avatar

setEmote

public void setEmote(java.lang.String emote)

Specified by:

setEmote in interface Avatar

log

public void log(java.lang.String message,
                java.util.logging.Level level,
                java.lang.Object... arguments)

Log the message if the debug level is greater or equal to the level.

log

public void log(java.lang.Throwable exception)

Log the exception.

getBot

public Bot getBot()

Return Bot.

Specified by:

getBot in interface Avatar

getPrimitive

public Primitive getPrimitive()

Specified by:

getPrimitive in interface Avatar

setBot

public void setBot(Bot bot)

Set Bot.

Specified by:

setBot in interface Avatar

initialize

public void initialize(java.util.Map<java.lang.String,java.lang.Object> properties)

Initialize any configurable settings from the properties.

Specified by:

initialize in interface Avatar

shutdown

public void shutdown()

Specified by:

shutdown in interface Avatar

awake

public void awake()

Specified by:

awake in interface Avatar

evaluateOutput

public void evaluateOutput(Vertex output)

Evaluate the output for emotional expression.

Specified by:

evaluateOutput in interface Avatar

evaluateResponse

public void evaluateResponse(Vertex output,
                             Vertex response,
                             Vertex meta,
                             java.util.Map<Vertex,Vertex> variables,
                             Network network)

Evaluate the input response for actions and poses.

Specified by:

evaluateResponse in interface Avatar

clearAvatarProperty

public java.lang.Long clearAvatarProperty()

emote

public void emote(EmotionalState state,
                  Network memory)

Output the emotional state to the Avatar.

getCurrentImage

public BinaryData getCurrentImage()

Specified by:

getCurrentImage in interface Avatar

toString

public java.lang.String toString()

Print a useful string representation of the avatar.

Overrides:

toString in class java.lang.Object

setAction

public Vertex setAction(Vertex source,
                        Vertex action)

Self API to set avatar action.

setPose

public Vertex setPose(Vertex source,
                      Vertex pose)

Self API to set avatar pose.

setCommand

public Vertex setCommand(Vertex source,
                         Vertex command)

Self API to set avatar command.