Fawkes API
Fawkes Development Version
|
FacialExpressionInterface Fawkes BlackBoard Interface. More...
#include <>>
Classes | |
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. More... | |
const char * | tostring_eyes_t (eyes_t value) const |
Convert eyes_t constant to string. More... | |
const char * | tostring_jowl_t (jowl_t value) const |
Convert jowl_t constant to string. More... | |
const char * | tostring_mouth_t (mouth_t value) const |
Convert mouth_t constant to string. More... | |
virtual bool | message_valid (const Message *message) const |
Check if message is valid and can be enqueued. More... | |
brows_t | brows_action () const |
Get brows_action value. More... | |
void | set_brows_action (const brows_t new_brows_action) |
Set brows_action value. More... | |
size_t | maxlenof_brows_action () const |
Get maximum length of brows_action value. More... | |
eyes_t | eyes_action () const |
Get eyes_action value. More... | |
void | set_eyes_action (const eyes_t new_eyes_action) |
Set eyes_action value. More... | |
size_t | maxlenof_eyes_action () const |
Get maximum length of eyes_action value. More... | |
jowl_t | jowl_action () const |
Get jowl_action value. More... | |
void | set_jowl_action (const jowl_t new_jowl_action) |
Set jowl_action value. More... | |
size_t | maxlenof_jowl_action () const |
Get maximum length of jowl_action value. More... | |
mouth_t | mouth_action () const |
Get mouth_action value. More... | |
void | set_mouth_action (const mouth_t new_mouth_action) |
Set mouth_action value. More... | |
size_t | maxlenof_mouth_action () const |
Get maximum length of mouth_action value. More... | |
virtual Message * | create_message (const char *type) const |
Create message based on type name. More... | |
virtual void | copy_values (const Interface *other) |
Copy values from other interface. More... | |
virtual const char * | enum_tostring (const char *enumtype, int val) const |
Convert arbitrary enum value to string. More... | |
![]() | |
virtual | ~Interface () |
Destructor. More... | |
bool | oftype (const char *interface_type) const |
Check if interface is of given type. More... | |
const void * | datachunk () const |
Get data chunk. More... | |
unsigned int | datasize () const |
Get data size. More... | |
const char * | type () const |
Get type of interface. More... | |
const char * | id () const |
Get identifier of interface. More... | |
const char * | uid () const |
Get unique identifier of interface. More... | |
unsigned short | serial () const |
Get instance serial of interface. More... | |
unsigned int | mem_serial () const |
Get memory serial of interface. More... | |
bool | operator== (Interface &comp) const |
Check equality of two interfaces. More... | |
const unsigned char * | hash () const |
Get interface hash. More... | |
size_t | hash_size () const |
Get size of interface hash. More... | |
const char * | hash_printable () const |
Get printable interface hash. More... | |
bool | is_writer () const |
Check if this is a writing instance. More... | |
void | set_validity (bool valid) |
Mark this interface invalid. More... | |
bool | is_valid () const |
Check validity of interface. More... | |
const char * | owner () const |
Get owner of interface. More... | |
void | set_from_chunk (void *chunk) |
Set from a raw data chunk. More... | |
void | resize_buffers (unsigned int num_buffers) |
Resize buffer array. More... | |
unsigned int | num_buffers () const |
Get number of buffers. More... | |
void | copy_shared_to_buffer (unsigned int buffer) |
Copy data from private memory to buffer. More... | |
void | copy_private_to_buffer (unsigned int buffer) |
Copy data from private memory to buffer. More... | |
void | read_from_buffer (unsigned int buffer) |
Copy data from buffer to private memory. More... | |
int | compare_buffers (unsigned int buffer) |
Compare buffer to private memory. More... | |
Time | buffer_timestamp (unsigned int buffer) |
Get time of a buffer. More... | |
void | buffer_timestamp (unsigned int buffer, Time *timestamp) |
Get time of a buffer. More... | |
void | read () |
Read from BlackBoard into local copy. More... | |
void | write () |
Write from local copy into BlackBoard memory. More... | |
bool | has_writer () const |
Check if there is a writer for the interface. More... | |
unsigned int | num_readers () const |
Get the number of readers. More... | |
std::string | writer () const |
Get owner name of writing interface instance. More... | |
std::list< std::string > | readers () const |
Get owner names of reading interface instances. More... | |
bool | changed () const |
Check if data has been changed. More... | |
const Time * | timestamp () const |
Get timestamp of last write. More... | |
void | set_auto_timestamping (bool enabled) |
Enable or disable automated timestamping. More... | |
void | set_timestamp (const Time *t=NULL) |
Set timestamp. More... | |
void | set_clock (Clock *clock) |
Set clock to use for timestamping. More... | |
void | mark_data_changed () |
Mark data as changed. More... | |
std::list< const char * > | get_message_types () |
Obtain a list of textual representations of the message types available for this interface. More... | |
unsigned int | msgq_enqueue (Message *message) |
Enqueue message at end of queue. More... | |
unsigned int | msgq_enqueue_copy (Message *message) |
Enqueue copy of message at end of queue. More... | |
void | msgq_remove (Message *message) |
Remove message from queue. More... | |
void | msgq_remove (unsigned int message_id) |
Remove message from queue. More... | |
unsigned int | msgq_size () |
Get size of message queue. More... | |
void | msgq_flush () |
Flush all messages. More... | |
void | msgq_lock () |
Lock message queue. More... | |
bool | msgq_try_lock () |
Try to lock message queue. More... | |
void | msgq_unlock () |
Unlock message queue. More... | |
void | msgq_pop () |
Erase first message from queue. More... | |
Message * | msgq_first () |
Get the first message from the message queue. More... | |
bool | msgq_empty () |
Check if queue is empty. More... | |
void | msgq_append (Message *message) |
Enqueue message. More... | |
template<class MessageType > | |
bool | msgq_first_is () |
Check if first message has desired type. More... | |
template<class MessageType > | |
MessageType * | msgq_first () |
Get first message casted to the desired type. More... | |
template<class MessageType > | |
MessageType * | msgq_first (MessageType *&msg) |
Get first message casted to the desired type. More... | |
template<class MessageType > | |
MessageType * | msgq_first_safe (MessageType *&msg) throw () |
Get first message casted to the desired type without exceptions. More... | |
MessageQueue::MessageIterator | msgq_begin () |
Get start iterator for message queue. More... | |
MessageQueue::MessageIterator | msgq_end () |
Get end iterator for message queue. More... | |
InterfaceFieldIterator | fields () |
Get iterator over all fields of this interface instance. More... | |
InterfaceFieldIterator | fields_end () |
Invalid iterator. More... | |
unsigned int | num_fields () |
Get the number of fields in the interface. More... | |
Additional Inherited Members | |
![]() | |
static void | parse_uid (const char *uid, std::string &type, std::string &id) |
Parse UID to type and ID strings. More... | |
![]() | |
Interface () | |
Constructor. More... | |
void | set_hash (unsigned char *ihash) |
Set hash. More... | |
void | add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0) |
Add an entry to the field info list. More... | |
void | add_messageinfo (const char *name) |
Add an entry to the message info list. More... | |
![]() | |
void * | data_ptr |
Pointer to local memory storage. More... | |
unsigned int | data_size |
Minimal data size to hold data storage. More... | |
bool | data_changed |
Indicator if data has changed. More... | |
interface_data_ts_t * | data_ts |
Pointer to data casted to timestamp struct. More... | |
FacialExpressionInterface Fawkes BlackBoard Interface.
Interface to acces facial expressions on display (RCSoft)
Definition at line 33 of file FacialExpressionInterface.h.
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.
FacialExpressionInterface::brows_t fawkes::FacialExpressionInterface::brows_action | ( | ) | const |
Get brows_action value.
Type of action of brows
Definition at line 160 of file FacialExpressionInterface.cpp.
|
virtual |
Copy values from other interface.
other | other interface to copy values from |
Implements fawkes::Interface.
Definition at line 302 of file FacialExpressionInterface.cpp.
References fawkes::Message::type(), and fawkes::Interface::type().
|
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.
type | message type |
UnknownTypeException | thrown if this interface cannot create a message of the given type. |
Implements fawkes::Interface.
Definition at line 281 of file FacialExpressionInterface.cpp.
|
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.
enumtype | enum type as string |
val | value to convert |
UnknownTypeException | thrown if enumtype is not specified for interface. |
Implements fawkes::Interface.
Definition at line 313 of file FacialExpressionInterface.cpp.
FacialExpressionInterface::eyes_t fawkes::FacialExpressionInterface::eyes_action | ( | ) | const |
Get eyes_action value.
Type of action of eyes
Definition at line 191 of file FacialExpressionInterface.cpp.
FacialExpressionInterface::jowl_t fawkes::FacialExpressionInterface::jowl_action | ( | ) | const |
Get jowl_action value.
Type of action of jown
Definition at line 222 of file FacialExpressionInterface.cpp.
size_t fawkes::FacialExpressionInterface::maxlenof_brows_action | ( | ) | const |
Get maximum length of brows_action value.
Definition at line 170 of file FacialExpressionInterface.cpp.
size_t fawkes::FacialExpressionInterface::maxlenof_eyes_action | ( | ) | const |
Get maximum length of eyes_action value.
Definition at line 201 of file FacialExpressionInterface.cpp.
size_t fawkes::FacialExpressionInterface::maxlenof_jowl_action | ( | ) | const |
Get maximum length of jowl_action value.
Definition at line 232 of file FacialExpressionInterface.cpp.
size_t fawkes::FacialExpressionInterface::maxlenof_mouth_action | ( | ) | const |
Get maximum length of mouth_action value.
Definition at line 263 of file FacialExpressionInterface.cpp.
|
virtual |
Check if message is valid and can be enqueued.
message | Message to check |
Implements fawkes::Interface.
Definition at line 856 of file FacialExpressionInterface.cpp.
FacialExpressionInterface::mouth_t fawkes::FacialExpressionInterface::mouth_action | ( | ) | const |
Get mouth_action value.
Type of action of mouth
Definition at line 253 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
new_brows_action | new brows_action value |
Definition at line 180 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
new_eyes_action | new eyes_action value |
Definition at line 211 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
new_jowl_action | new jowl_action value |
Definition at line 242 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
new_mouth_action | new mouth_action value |
Definition at line 273 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.
value | value to convert to string |
Definition at line 95 of file FacialExpressionInterface.cpp.
const char * fawkes::FacialExpressionInterface::tostring_eyes_t | ( | eyes_t | value | ) | const |
Convert eyes_t constant to string.
value | value to convert to string |
Definition at line 109 of file FacialExpressionInterface.cpp.
const char * fawkes::FacialExpressionInterface::tostring_jowl_t | ( | jowl_t | value | ) | const |
Convert jowl_t constant to string.
value | value to convert to string |
Definition at line 129 of file FacialExpressionInterface.cpp.
const char * fawkes::FacialExpressionInterface::tostring_mouth_t | ( | mouth_t | value | ) | const |
Convert mouth_t constant to string.
value | value to convert to string |
Definition at line 143 of file FacialExpressionInterface.cpp.