edu::wpi::hri::gen::ebml::SpeechOption Class Reference

List of all members.

Public Member Functions
double	getCost ()
DistractorSet	getDistractors ()
String	getID ()
double	getReliability ()
String	getText ()
boolean	isDeictic ()
Package Functions
	SpeechOption (Logger logger, Element elem, String name)
Private Attributes
final double	cost
final boolean	deictic
final DistractorSet	distractors
final String	id
final Logger	logger
final String	text
Static Private Attributes
static final String	COST_ATTR = "cost"
static final String	DEICTIC_ATTR = "deictic"
static final String	DISTRACTOR_ELEM = "distractor"
static final String	OBJECT_ATTR = "object"
static final String	TEXT_ATTR = "text"

---

Detailed Description

A Speech Option is a phrase which can be said for a cost. These objects are used in the reference policy to determine the correct gesture speech pair to use.

Author:

Aaron Holroyd (aholroyd (at) wpi (dot) edu)

Definition at line 55 of file SpeechOption.java.

---

Constructor & Destructor Documentation

edu::wpi::hri::gen::ebml::SpeechOption::SpeechOption	(	Logger	logger,
		Element	elem,
		String	name
	)			[inline, package]

Create a new speech option from the given element which was passed in by the outside world. These are associated with a reference and therefore can only be created by reference behaviors.

Parameters:

	logger	the logger to store information to
	elem	the element to parse which is a speech option.
	name	the name of the speech option as told by the reference

Definition at line 82 of file SpeechOption.java.

---

Member Function Documentation

double edu::wpi::hri::gen::ebml::SpeechOption::getCost

(

)

[inline]

Get the cost of the phrase to speak.

Returns:

the cost of the speech.

Definition at line 111 of file SpeechOption.java.

DistractorSet edu::wpi::hri::gen::ebml::SpeechOption::getDistractors

(

)

[inline]

With great words, comes a great reduction of the distractor set.

Returns:

The distractors remaining after speaking the words.

Definition at line 139 of file SpeechOption.java.

String edu::wpi::hri::gen::ebml::SpeechOption::getID

(

)

[inline]

Get the id of this speech option. Probably, this comes from the reference and something else this is in.

Returns:

The id of this speech option.

Definition at line 149 of file SpeechOption.java.

double edu::wpi::hri::gen::ebml::SpeechOption::getReliability

(

)

[inline]

Get the inherent reliability of speech.

Returns:

The inherent reliability of speech.

Definition at line 158 of file SpeechOption.java.

String edu::wpi::hri::gen::ebml::SpeechOption::getText

(

)

[inline]

Get the phrase to speak.

Returns:

the phrase to speak.

Definition at line 120 of file SpeechOption.java.

boolean edu::wpi::hri::gen::ebml::SpeechOption::isDeictic

(

)

[inline]

Get if this reference is a deictic reference, therefore it requires a point.

Returns:

If the reference is deictic

Definition at line 130 of file SpeechOption.java.

---

Member Data Documentation

final double edu::wpi::hri::gen::ebml::SpeechOption::cost [private]

Definition at line 66 of file SpeechOption.java.

final String edu::wpi::hri::gen::ebml::SpeechOption::COST_ATTR = "cost" [static, private]

Definition at line 58 of file SpeechOption.java.

final boolean edu::wpi::hri::gen::ebml::SpeechOption::deictic [private]

Definition at line 67 of file SpeechOption.java.

final String edu::wpi::hri::gen::ebml::SpeechOption::DEICTIC_ATTR = "deictic" [static, private]

Definition at line 61 of file SpeechOption.java.

final String edu::wpi::hri::gen::ebml::SpeechOption::DISTRACTOR_ELEM = "distractor" [static, private]

Definition at line 59 of file SpeechOption.java.

final DistractorSet edu::wpi::hri::gen::ebml::SpeechOption::distractors [private]

Definition at line 68 of file SpeechOption.java.

final String edu::wpi::hri::gen::ebml::SpeechOption::id [private]

Definition at line 64 of file SpeechOption.java.

final Logger edu::wpi::hri::gen::ebml::SpeechOption::logger [private]

Definition at line 63 of file SpeechOption.java.

final String edu::wpi::hri::gen::ebml::SpeechOption::OBJECT_ATTR = "object" [static, private]

Definition at line 60 of file SpeechOption.java.

final String edu::wpi::hri::gen::ebml::SpeechOption::text [private]

Definition at line 65 of file SpeechOption.java.

final String edu::wpi::hri::gen::ebml::SpeechOption::TEXT_ATTR = "text" [static, private]

Definition at line 57 of file SpeechOption.java.

---

The documentation for this class was generated from the following file:

• engagement_generation/src/edu/wpi/hri/gen/ebml/SpeechOption.java