Fawkes API Fawkes Development Version

fawkes::SkillerInterface::ExecSkillMessage Class Reference

ExecSkillMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::SkillerInterface::ExecSkillMessage:

List of all members.

Classes

struct  ExecSkillMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 ExecSkillMessage (const char *ini_skill_string)
 Constructor with initial values.
 ExecSkillMessage ()
 Constructor.
 ~ExecSkillMessage ()
 Destructor.
 ExecSkillMessage (const ExecSkillMessage *m)
 Copy constructor.
char * skill_string () const
 Get skill_string value.
void set_skill_string (const char *new_skill_string)
 Set skill_string value.
size_t maxlenof_skill_string () const
 Get maximum length of skill_string value.
virtual Messageclone () const
 Clone this message.

Detailed Description

ExecSkillMessage Fawkes BlackBoard Interface Message.

Definition at line 84 of file SkillerInterface.h.


Constructor & Destructor Documentation

fawkes::SkillerInterface::ExecSkillMessage::ExecSkillMessage ( const char *  ini_skill_string)

Constructor with initial values.

Parameters:
ini_skill_stringinitial value for skill_string

Definition at line 330 of file SkillerInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_STRING.

fawkes::SkillerInterface::ExecSkillMessage::ExecSkillMessage ( )
fawkes::SkillerInterface::ExecSkillMessage::~ExecSkillMessage ( )

Destructor.

Definition at line 352 of file SkillerInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::SkillerInterface::ExecSkillMessage::ExecSkillMessage ( const ExecSkillMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 360 of file SkillerInterface.cpp.

References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.


Member Function Documentation

Message * fawkes::SkillerInterface::ExecSkillMessage::clone ( ) const [virtual]

Clone this message.

Produces a message of the same type as this message and copies the data to the new message.

Returns:
clone of this message

Reimplemented from fawkes::Message.

Definition at line 412 of file SkillerInterface.cpp.

size_t fawkes::SkillerInterface::ExecSkillMessage::maxlenof_skill_string ( ) const

Get maximum length of skill_string value.

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

Definition at line 388 of file SkillerInterface.cpp.

void fawkes::SkillerInterface::ExecSkillMessage::set_skill_string ( const char *  new_skill_string)

Set skill_string value.

Currently executed skill string, at least the first 1023 bytes of it. Must be properly null-terminated.

Parameters:
new_skill_stringnew skill_string value

Definition at line 401 of file SkillerInterface.cpp.

char * fawkes::SkillerInterface::ExecSkillMessage::skill_string ( ) const

Get skill_string value.

Currently executed skill string, at least the first 1023 bytes of it. Must be properly null-terminated.

Returns:
skill_string value

Definition at line 378 of file SkillerInterface.cpp.

Referenced by SkillerExecutionThread::loop().


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends