hmi.elckerlyc
Interface Player

All Known Implementing Classes:

AnimationPlayer, AudioPlayer, FacePlayer, InterruptPlayer, VerbalPlayer, WaitPlayer

public interface Player

Elckerlyc player. A player belongs to a planner. A player can be reset (see e.g. BMLRealizer.reset()). In the future, more generic methods may be added to this interface...

Author:

Herwin van Welbergen, Dennis Reidsma

Method Summary

void	addExceptionListener(BMLExceptionListener es)
Set<String>	getBehaviours(String bmlId)
double	getEndTime(String behId, String bmlId)
void	interruptBehaviourBlock(String bmlId, double time) Interrupts all behaviors in the block; that is: calls their stop and removes them from the plan
void	removeAllExceptionListeners()
void	reset() Reset the player.
void	setBMLBlockState(String bmlId, PlanUnitState state)
void	setParameterValue(String behId, String bmlId, String paramId, float value)
void	setParameterValue(String behId, String bmlId, String paramId, String value)
void	shutdown() Clean up resources constructed with the planner (e.g. for native stuff, spawned threads, ...).

Method Detail

reset

void reset()

Reset the player.

addExceptionListener

void addExceptionListener(BMLExceptionListener es)

removeAllExceptionListeners

void removeAllExceptionListeners()

setBMLBlockState

void setBMLBlockState(String bmlId,
                      PlanUnitState state)

getBehaviours

Set<String> getBehaviours(String bmlId)

getEndTime

double getEndTime(String behId,
                  String bmlId)

interruptBehaviourBlock

void interruptBehaviourBlock(String bmlId,
                             double time)

Interrupts all behaviors in the block; that is: calls their stop and removes them from the plan

setParameterValue

void setParameterValue(String behId,
                       String bmlId,
                       String paramId,
                       float value)

setParameterValue

void setParameterValue(String behId,
                       String bmlId,
                       String paramId,
                       String value)

shutdown

void shutdown()

Clean up resources constructed with the planner (e.g. for native stuff, spawned threads, ...). A planner should not be (re)used after shutting it down.