APServiceResponse Class Reference

#include <ap_service_response.h>

Inheritance diagram for APServiceResponse:

Public Member Functions
	APServiceResponse ()
std::string	getData ()
bool	isExtendedAction ()
bool	isLook ()
bool	isNoAction ()
bool	isNod ()
bool	isPoint ()
bool	isShake ()
bool	isSpeech ()
void	setCycle ()
void	setData (std::string data)
void	setExtendedAction (std::string data="")
void	setFailed ()
void	setLook (std::string data="")
void	setNoAction ()
void	setNod ()
void	setPoint (std::string data="")
void	setShake ()
void	setSpeech (std::string data="")
Static Public Member Functions
static APServiceResponse	cycle ()
static APServiceResponse	extendedAction ()
static APServiceResponse	failed ()
static APServiceResponse	look ()
static APServiceResponse	noAction ()
static APServiceResponse	nod ()
static APServiceResponse	point ()
static APServiceResponse	shake ()
static APServiceResponse	speech ()
Protected Member Functions
	APServiceResponse (Action action)
Protected Attributes
Action	action_

Detailed Description

The APServiceResponse class is responsible for encapsulating the returned status for the Adjacency Pair recognizer. It returns the action that successfully completed the service--or that the service is cycling or failed.

Author:: Brett Ponsler (bponsler (at) wpi (dot) edu)

Definition at line 49 of file ap_service_response.h.

Constructor & Destructor Documentation

APServiceResponse::APServiceResponse ( Action action ) [protected]

Constructor for the APServiceResponse class. Create an APServiceResponse with the given action.

Definition at line 43 of file ap_service_response.cpp.

APServiceResponse::APServiceResponse ( )

Default constructor for the APServiceResponse class.

Definition at line 37 of file ap_service_response.cpp.

Member Function Documentation

APServiceResponse APServiceResponse::cycle ( ) [static]

Create a ServiceResponse that is the cycle status.

Returns:: The ServiceResponse

Reimplemented from ServiceResponse.

Definition at line 49 of file ap_service_response.cpp.

APServiceResponse APServiceResponse::extendedAction ( ) [static]

The service call succeeded due to the human performing an extended action.

Returns:: The resulting status

Definition at line 100 of file ap_service_response.cpp.

APServiceResponse APServiceResponse::failed ( ) [static]

Create a ServiceResponse that is the failed status.

Returns:: The ServiceResponse

Reimplemented from ServiceResponse.

Definition at line 55 of file ap_service_response.cpp.

std::string APServiceResponse::getData ( )

Return the additional data.

Returns:: The data

Definition at line 65 of file ap_service_response.cpp.

bool APServiceResponse::isExtendedAction ( )

Determine if this APServiceResponse was completed with an extended action.

Returns:: True if completed with an extended action, false otherwise

Definition at line 194 of file ap_service_response.cpp.

bool APServiceResponse::isLook ( )

Determine if this APServiceResponse was completed with a look.

Returns:: True if completed with a look, false otherwise

Definition at line 189 of file ap_service_response.cpp.

bool APServiceResponse::isNoAction ( )

Determine if this APServiceResponse was completed with no action.

Returns:: True if completed with no action, false otherwise

Definition at line 164 of file ap_service_response.cpp.

bool APServiceResponse::isNod ( )

Determine if this APServiceResponse was completed with a nod.

Returns:: True if completed with a nod, false otherwise

Definition at line 169 of file ap_service_response.cpp.

bool APServiceResponse::isPoint ( )

Determine if this APServiceResponse was completed with a point.

Returns:: True if completed with a point, false otherwise

Definition at line 184 of file ap_service_response.cpp.

bool APServiceResponse::isShake ( )

Determine if this APServiceResponse was completed with a shake.

Returns:: True if completed with a shake, false otherwise

Definition at line 174 of file ap_service_response.cpp.

bool APServiceResponse::isSpeech ( )

Determine if this APServiceResponse was completed with speech.

Returns:: True if completed with speech, false otherwise

Definition at line 179 of file ap_service_response.cpp.

APServiceResponse APServiceResponse::look ( ) [static]

The service call succeeded due to the human looked.

Returns:: The resulting status

Definition at line 95 of file ap_service_response.cpp.

APServiceResponse APServiceResponse::noAction ( ) [static]

The service call did not perform an action.

Returns:: The resulting status

Definition at line 70 of file ap_service_response.cpp.

APServiceResponse APServiceResponse::nod ( ) [static]

The service call succeeded due to the human nodding his head.

Returns:: The resulting status

Definition at line 75 of file ap_service_response.cpp.

APServiceResponse APServiceResponse::point ( ) [static]

The service call succeeded due to the human pointing.

Returns:: The resulting status

Definition at line 90 of file ap_service_response.cpp.

void APServiceResponse::setCycle ( ) [virtual]

Set this action to a cycle action.

Reimplemented from ServiceResponse.

Definition at line 110 of file ap_service_response.cpp.

void APServiceResponse::setData ( std::string data )

Set the data for this service response.

Parameters:

data

The data

Definition at line 105 of file ap_service_response.cpp.

void APServiceResponse::setExtendedAction ( std::string data = "" )

Set this action to an extended action.

Parameters:

data

The additional data

Definition at line 158 of file ap_service_response.cpp.

void APServiceResponse::setFailed ( ) [virtual]

Set this action to a failed action.

Reimplemented from ServiceResponse.

Definition at line 116 of file ap_service_response.cpp.

void APServiceResponse::setLook ( std::string data = "" )

Set this action to a look action.

Parameters:

data

The additional data

Definition at line 152 of file ap_service_response.cpp.

void APServiceResponse::setNoAction ( )

Set this action to no action.

Definition at line 122 of file ap_service_response.cpp.

void APServiceResponse::setNod ( )

Set this action to a nod action.

Definition at line 128 of file ap_service_response.cpp.

void APServiceResponse::setPoint ( std::string data = "" )

Set this action to a point action.

Parameters:

data

The additional data

Definition at line 146 of file ap_service_response.cpp.

void APServiceResponse::setShake ( )

Set this action to a shake action.

Definition at line 134 of file ap_service_response.cpp.

void APServiceResponse::setSpeech ( std::string data = "" )

Set this action to a speech action.

Parameters:

data

The additional data

Definition at line 140 of file ap_service_response.cpp.

APServiceResponse APServiceResponse::shake ( ) [static]

The service call succeeded due to the human shaking his head.

Returns:: The resulting status

Definition at line 80 of file ap_service_response.cpp.

APServiceResponse APServiceResponse::speech ( ) [static]

The service call succeeded due to the human speaking.

Returns:: The resulting status

Definition at line 85 of file ap_service_response.cpp.

Member Data Documentation

Action APServiceResponse::action_ [protected]

The action that was used to complete the event.

Definition at line 53 of file ap_service_response.h.

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

engagement_recognition/src/recognition/response/ap_service_response.h
engagement_recognition/src/recognition/response/ap_service_response.cpp

APServiceResponse Class Reference

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation