fawkes::FacialExpressionInterface Class Reference
[Fawkes Interfaces]

FacialExpressionInterface Fawkes BlackBoard Interface. More...

#include <interfaces/FacialExpressionInterface.h>

Inheritance diagram for fawkes::FacialExpressionInterface:
Inheritance graph
[legend]

List of all members.

Classes

struct  FacialExpressionInterface_data_t
 Internal data storage, do NOT modify!
class  MoveBrowsMessage
 MoveBrowsMessage Fawkes BlackBoard Interface Message. More...
class  MoveEyesMessage
 MoveEyesMessage Fawkes BlackBoard Interface Message. More...
class  MoveJowlMessage
 MoveJowlMessage Fawkes BlackBoard Interface Message. More...
class  MoveMouthMessage
 MoveMouthMessage Fawkes BlackBoard Interface Message. More...

Public Types

enum  brows_t { BROWS_DEFAULT, BROWS_FROWN, BROWS_LIFT }
 

Action types for moving brows.

More...
enum  eyes_t {
  EYES_DEFAULT, EYES_UP, EYES_DOWN, EYES_LEFT,
  EYES_RIGHT, EYES_COOL, EYES_CROSS, EYES_HEART,
  EYES_DOLLAR
}
 

Action types for moving eyes.

More...
enum  jowl_t { JOWL_DEFAULT, JOWL_BLUSH, JOWL_TEARS }
 

Action types for moving jowl.

More...
enum  mouth_t {
  MOUTH_DEFAULT, MOUTH_OPEN, MOUTH_CLOSE, MOUTH_SMILE,
  MOUTH_SCOWL
}
 

Action types for moving mouth.

More...

Public Member Functions

const char * tostring_brows_t (brows_t value) const
 Convert brows_t constant to string.
const char * tostring_eyes_t (eyes_t value) const
 Convert eyes_t constant to string.
const char * tostring_jowl_t (jowl_t value) const
 Convert jowl_t constant to string.
const char * tostring_mouth_t (mouth_t value) const
 Convert mouth_t constant to string.
virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued.
brows_t brows_action () const
 Get brows_action value.
void set_brows_action (const brows_t new_brows_action)
 Set brows_action value.
size_t maxlenof_brows_action () const
 Get maximum length of brows_action value.
eyes_t eyes_action () const
 Get eyes_action value.
void set_eyes_action (const eyes_t new_eyes_action)
 Set eyes_action value.
size_t maxlenof_eyes_action () const
 Get maximum length of eyes_action value.
jowl_t jowl_action () const
 Get jowl_action value.
void set_jowl_action (const jowl_t new_jowl_action)
 Set jowl_action value.
size_t maxlenof_jowl_action () const
 Get maximum length of jowl_action value.
mouth_t mouth_action () const
 Get mouth_action value.
void set_mouth_action (const mouth_t new_mouth_action)
 Set mouth_action value.
size_t maxlenof_mouth_action () const
 Get maximum length of mouth_action value.
virtual Messagecreate_message (const char *type) const
 Create message based on type name.
virtual void copy_values (const Interface *other)
 Copy values from other interface.
virtual const char * enum_tostring (const char *enumtype, int val) const
 Convert arbitrary enum value to string.

Detailed Description

FacialExpressionInterface Fawkes BlackBoard Interface.

Interface to acces facial expressions on display (RCSoft)

Definition at line 33 of file FacialExpressionInterface.h.


Member Enumeration Documentation

Action types for moving brows.

Enumerator:
BROWS_DEFAULT 

Reset.

BROWS_FROWN 

Frown.

BROWS_LIFT 

Lift.

Definition at line 42 of file FacialExpressionInterface.h.

Action types for moving eyes.

Enumerator:
EYES_DEFAULT 

Reset.

EYES_UP 

Up.

EYES_DOWN 

Down.

EYES_LEFT 

Left.

EYES_RIGHT 

Right.

EYES_COOL 

Cool.

EYES_CROSS 

Cross.

EYES_HEART 

Heart.

EYES_DOLLAR 

Dollar.

Definition at line 50 of file FacialExpressionInterface.h.

Action types for moving jowl.

Enumerator:
JOWL_DEFAULT 

Reset.

JOWL_BLUSH 

Blush.

JOWL_TEARS 

Tears.

Definition at line 64 of file FacialExpressionInterface.h.

Action types for moving mouth.

Enumerator:
MOUTH_DEFAULT 

Reset.

MOUTH_OPEN 

Open.

MOUTH_CLOSE 

Close.

MOUTH_SMILE 

Smile.

MOUTH_SCOWL 

Scowl.

Definition at line 72 of file FacialExpressionInterface.h.


Member Function Documentation

FacialExpressionInterface::brows_t fawkes::FacialExpressionInterface::brows_action (  )  const

Get brows_action value.

Type of action of brows

Returns:
brows_action value

Definition at line 138 of file FacialExpressionInterface.cpp.

void fawkes::FacialExpressionInterface::copy_values ( const Interface other  )  [virtual]

Copy values from other interface.

Parameters:
other other interface to copy values from

Definition at line 280 of file FacialExpressionInterface.cpp.

References fawkes::Interface::type().

Message * fawkes::FacialExpressionInterface::create_message ( const char *  type  )  const [virtual]

Create message based on type name.

This will create a new message of the given type. The type must be given without the InterfaceName:: prefix but just the plain class name of the message.

Parameters:
type message type
Returns:
message of the given type, empty
Exceptions:
UnknownTypeException thrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 259 of file FacialExpressionInterface.cpp.

const char * fawkes::FacialExpressionInterface::enum_tostring ( const char *  enumtype,
int  val 
) const [virtual]

Convert arbitrary enum value to string.

Given the string representation of the enum type and the value this method returns the string representation of the specific value, or the string UNKNOWN if the value is not defined. An exception is thrown if the enum type is invalid.

Parameters:
enumtype enum type as string
val value to convert
Returns:
string representation of value
Exceptions:
UnknownTypeException thrown if enumtype is not specified for interface.

Implements fawkes::Interface.

Definition at line 291 of file FacialExpressionInterface.cpp.

References tostring_brows_t(), tostring_eyes_t(), tostring_jowl_t(), and tostring_mouth_t().

FacialExpressionInterface::eyes_t fawkes::FacialExpressionInterface::eyes_action (  )  const

Get eyes_action value.

Type of action of eyes

Returns:
eyes_action value

Definition at line 169 of file FacialExpressionInterface.cpp.

FacialExpressionInterface::jowl_t fawkes::FacialExpressionInterface::jowl_action (  )  const

Get jowl_action value.

Type of action of jown

Returns:
jowl_action value

Definition at line 200 of file FacialExpressionInterface.cpp.

size_t fawkes::FacialExpressionInterface::maxlenof_brows_action (  )  const

Get maximum length of brows_action value.

Returns:
length of brows_action value, can be length of the array or number of maximum number of characters for a string

Definition at line 148 of file FacialExpressionInterface.cpp.

size_t fawkes::FacialExpressionInterface::maxlenof_eyes_action (  )  const

Get maximum length of eyes_action value.

Returns:
length of eyes_action value, can be length of the array or number of maximum number of characters for a string

Definition at line 179 of file FacialExpressionInterface.cpp.

size_t fawkes::FacialExpressionInterface::maxlenof_jowl_action (  )  const

Get maximum length of jowl_action value.

Returns:
length of jowl_action value, can be length of the array or number of maximum number of characters for a string

Definition at line 210 of file FacialExpressionInterface.cpp.

size_t fawkes::FacialExpressionInterface::maxlenof_mouth_action (  )  const

Get maximum length of mouth_action value.

Returns:
length of mouth_action value, can be length of the array or number of maximum number of characters for a string

Definition at line 241 of file FacialExpressionInterface.cpp.

bool fawkes::FacialExpressionInterface::message_valid ( const Message message  )  const [virtual]

Check if message is valid and can be enqueued.

Parameters:
message Message to check
Returns:
true if the message is valid, false otherwise.

Implements fawkes::Interface.

Definition at line 674 of file FacialExpressionInterface.cpp.

FacialExpressionInterface::mouth_t fawkes::FacialExpressionInterface::mouth_action (  )  const

Get mouth_action value.

Type of action of mouth

Returns:
mouth_action value

Definition at line 231 of file FacialExpressionInterface.cpp.

void fawkes::FacialExpressionInterface::set_brows_action ( const brows_t  new_brows_action  ) 

Set brows_action value.

Type of action of brows

Parameters:
new_brows_action new brows_action value

Definition at line 158 of file FacialExpressionInterface.cpp.

References fawkes::Interface::data_changed.

void fawkes::FacialExpressionInterface::set_eyes_action ( const eyes_t  new_eyes_action  ) 

Set eyes_action value.

Type of action of eyes

Parameters:
new_eyes_action new eyes_action value

Definition at line 189 of file FacialExpressionInterface.cpp.

References fawkes::Interface::data_changed.

void fawkes::FacialExpressionInterface::set_jowl_action ( const jowl_t  new_jowl_action  ) 

Set jowl_action value.

Type of action of jown

Parameters:
new_jowl_action new jowl_action value

Definition at line 220 of file FacialExpressionInterface.cpp.

References fawkes::Interface::data_changed.

void fawkes::FacialExpressionInterface::set_mouth_action ( const mouth_t  new_mouth_action  ) 

Set mouth_action value.

Type of action of mouth

Parameters:
new_mouth_action new mouth_action value

Definition at line 251 of file FacialExpressionInterface.cpp.

References fawkes::Interface::data_changed.

const char * fawkes::FacialExpressionInterface::tostring_brows_t ( brows_t  value  )  const

Convert brows_t constant to string.

Parameters:
value value to convert to string
Returns:
constant value as string.

Definition at line 73 of file FacialExpressionInterface.cpp.

References BROWS_DEFAULT, BROWS_FROWN, and BROWS_LIFT.

Referenced by enum_tostring().

const char * fawkes::FacialExpressionInterface::tostring_eyes_t ( eyes_t  value  )  const

Convert eyes_t constant to string.

Parameters:
value value to convert to string
Returns:
constant value as string.

Definition at line 87 of file FacialExpressionInterface.cpp.

References EYES_COOL, EYES_CROSS, EYES_DEFAULT, EYES_DOLLAR, EYES_DOWN, EYES_HEART, EYES_LEFT, EYES_RIGHT, and EYES_UP.

Referenced by enum_tostring().

const char * fawkes::FacialExpressionInterface::tostring_jowl_t ( jowl_t  value  )  const

Convert jowl_t constant to string.

Parameters:
value value to convert to string
Returns:
constant value as string.

Definition at line 107 of file FacialExpressionInterface.cpp.

References JOWL_BLUSH, JOWL_DEFAULT, and JOWL_TEARS.

Referenced by enum_tostring().

const char * fawkes::FacialExpressionInterface::tostring_mouth_t ( mouth_t  value  )  const

Convert mouth_t constant to string.

Parameters:
value value to convert to string
Returns:
constant value as string.

Definition at line 121 of file FacialExpressionInterface.cpp.

References MOUTH_CLOSE, MOUTH_DEFAULT, MOUTH_OPEN, MOUTH_SCOWL, and MOUTH_SMILE.

Referenced by enum_tostring().


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

Generated on 1 Mar 2011 for Fawkes API by  doxygen 1.6.1