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

Inheritance diagram for edu::wpi::hri::gen::ebml::ReferenceBehavior:

[legend]

List of all members.

Public Member Functions
double	getMinReliability ()
List< SpeechOption >	getSpeechOptions ()
String	getTarget ()
Protected Member Functions
void	appendAttributes (Document doc, Element elem)
String	getElementName ()
Package Functions
	ReferenceBehavior (Logger logger, Element elem)
Private Attributes
final double	minReliability
final List< SpeechOption >	speechOptions
final String	target
Static Private Attributes
static final String	RELIABILITY_ATTR = "minReliability"
static final String	SPEECH_ELEM = "speechOption"
static final String	TARGET_ATTR = "target"

---

Detailed Description

A reference behavior comes in from the outside world in a communication unit and is executed by the reference policy in RICEAdvisor. Reference Behavior objects can only be created in the EBMLList object since they are only created from an ebml string.

Author:

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

Definition at line 55 of file ReferenceBehavior.java.

---

Constructor & Destructor Documentation

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

Create a new reference behavior with the given logger and from the given element with name of reference.

Parameters:

	logger	the logger to use
	elem	the element to parse as a reference behavior

Definition at line 74 of file ReferenceBehavior.java.

---

Member Function Documentation

void edu::wpi::hri::gen::ebml::ReferenceBehavior::appendAttributes	(	Document	doc,
		Element	elem
	)			[inline, protected]

Definition at line 121 of file ReferenceBehavior.java.

String edu::wpi::hri::gen::ebml::ReferenceBehavior::getElementName

(

)

[inline, protected]

Definition at line 126 of file ReferenceBehavior.java.

double edu::wpi::hri::gen::ebml::ReferenceBehavior::getMinReliability

(

)

[inline]

Get the minimum reliability needed for the reference.

Returns:

the 0 < minimum reliability < 1

Definition at line 98 of file ReferenceBehavior.java.

List<SpeechOption> edu::wpi::hri::gen::ebml::ReferenceBehavior::getSpeechOptions

(

)

[inline]

Get the options which are available for speech

Returns:

Definition at line 116 of file ReferenceBehavior.java.

String edu::wpi::hri::gen::ebml::ReferenceBehavior::getTarget

(

)

[inline]

Get the object which is being referenced.

Returns:

the target object

Definition at line 107 of file ReferenceBehavior.java.

---

Member Data Documentation

final double edu::wpi::hri::gen::ebml::ReferenceBehavior::minReliability [private]

Definition at line 62 of file ReferenceBehavior.java.

final String edu::wpi::hri::gen::ebml::ReferenceBehavior::RELIABILITY_ATTR = "minReliability" [static, private]

Definition at line 58 of file ReferenceBehavior.java.

final String edu::wpi::hri::gen::ebml::ReferenceBehavior::SPEECH_ELEM = "speechOption" [static, private]

Definition at line 59 of file ReferenceBehavior.java.

final List<SpeechOption> edu::wpi::hri::gen::ebml::ReferenceBehavior::speechOptions [private]

Definition at line 63 of file ReferenceBehavior.java.

final String edu::wpi::hri::gen::ebml::ReferenceBehavior::target [private]

Definition at line 61 of file ReferenceBehavior.java.

final String edu::wpi::hri::gen::ebml::ReferenceBehavior::TARGET_ATTR = "target" [static, private]

Definition at line 57 of file ReferenceBehavior.java.

---

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

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