walker.blue.core.lib.speech

Class GeneratedSpeech

java.lang.Object

walker.blue.core.lib.speech.GeneratedSpeech

public class GeneratedSpeech
extends java.lang.Object

Class which holds all the values calculated when generating speech that will be spoken to the user

Constructor Summary

Constructors

Constructor and Description
GeneratedSpeech(double distance, NodeEvent event, NodeDirection direction) Contructor.

Method Summary

Modifier and Type	Method and Description
NodeDirection	getDirection() Getter for the direction field
double	getDistance() Getter for the distance field
NodeEvent	getEvent() Getter for the event field
java.lang.String	toActionString() Converts the generated speech to its action string
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

GeneratedSpeech

public GeneratedSpeech(double distance,
                       NodeEvent event,
                       NodeDirection direction)

Contructor. Sets the fields to the given values

Parameters:

distance - Distance until the next event

event - Type of the next event

direction - Direction of the next event

Method Detail

getDistance

public double getDistance()

Getter for the distance field

Returns:

Distance until the next event

getEvent

public NodeEvent getEvent()

Getter for the event field

Returns:

Type of the next event

getDirection

public NodeDirection getDirection()

Getter for the direction field

Returns:

Direction of the next event

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toActionString

public java.lang.String toActionString()

Converts the generated speech to its action string

Returns:

action string for the generated speech