Fawkes API
Fawkes Development Version
|
24 #ifndef _INTERFACES_SKILLERINTERFACE_H_
25 #define _INTERFACES_SKILLERINTERFACE_H_
27 #include <interface/interface.h>
28 #include <interface/message.h>
29 #include <interface/field_iterator.h>
33 class SkillerInterface :
public Interface
36 INTERFACE_MGMT_FRIENDS(SkillerInterface)
55 int64_t timestamp_sec;
56 int64_t timestamp_usec;
76 } SkillerInterface_data_t;
78 SkillerInterface_data_t *data;
83 class ExecSkillMessage :
public Message
88 int64_t timestamp_sec;
89 int64_t timestamp_usec;
94 } ExecSkillMessage_data_t;
96 ExecSkillMessage_data_t *data;
117 int64_t timestamp_sec;
118 int64_t timestamp_usec;
119 } RestartInterpreterMessage_data_t;
121 RestartInterpreterMessage_data_t *data;
138 int64_t timestamp_sec;
139 int64_t timestamp_usec;
140 } StopExecMessage_data_t;
142 StopExecMessage_data_t *data;
159 int64_t timestamp_sec;
160 int64_t timestamp_usec;
167 } AcquireControlMessage_data_t;
169 AcquireControlMessage_data_t *data;
185 class ReleaseControlMessage :
public Message
190 int64_t timestamp_sec;
191 int64_t timestamp_usec;
192 } ReleaseControlMessage_data_t;
194 ReleaseControlMessage_data_t *data;
216 char *
error()
const;
222 uint32_t
msgid()
const;
223 void set_msgid(
const uint32_t new_msgid);
231 virtual const char *
enum_tostring(
const char *enumtype,
int val)
const;
virtual void copy_values(const Interface *other)
Copy values from other interface.
void set_exclusive_controller(const uint32_t new_exclusive_controller)
Set exclusive_controller value.
~ReleaseControlMessage()
Destructor.
virtual Message * clone() const
Clone this message.
void set_steal_control(const bool new_steal_control)
Set steal_control value.
const char * tostring_SkillStatusEnum(SkillStatusEnum value) const
Convert SkillStatusEnum constant to string.
bool is_steal_control() const
Get steal_control value.
RestartInterpreterMessage()
Constructor.
@ S_RUNNING
The execution is still running.
size_t maxlenof_skill_string() const
Get maximum length of skill_string value.
void set_msgid(const uint32_t new_msgid)
Set msgid value.
ExecSkillMessage()
Constructor.
size_t maxlenof_skill_string() const
Get maximum length of skill_string value.
const char * type() const
Get type of interface.
virtual Message * clone() const
Clone this message.
size_t maxlenof_error() const
Get maximum length of error value.
SkillStatusEnum
This determines the current status of skill execution.
size_t maxlenof_exclusive_controller() const
Get maximum length of exclusive_controller value.
@ S_FINAL
The skill string has been successfully processed.
~RestartInterpreterMessage()
Destructor.
void set_error(const char *new_error)
Set error value.
void set_status(const SkillStatusEnum new_status)
Set status value.
@ S_FAILED
The execution failed and cannot succeed anymore.
SkillStatusEnum status() const
Get status value.
virtual Message * clone() const
Clone this message.
virtual Message * clone() const
Clone this message.
uint32_t msgid() const
Get msgid value.
virtual Message * create_message(const char *type) const
~ExecSkillMessage()
Destructor.
AcquireControlMessage()
Constructor.
std::map< int, std::string > interface_enum_map_t
Map of enum integer to string values.
char * skill_string() const
Get skill_string value.
char * skill_string() const
Get skill_string value.
char * error() const
Get error value.
size_t maxlenof_status() const
Get maximum length of status value.
void set_skill_string(const char *new_skill_string)
Set skill_string value.
ReleaseControlMessage()
Constructor.
void set_skill_string(const char *new_skill_string)
Set skill_string value.
~AcquireControlMessage()
Destructor.
uint32_t exclusive_controller() const
Get exclusive_controller value.
size_t maxlenof_steal_control() const
Get maximum length of steal_control value.
virtual const char * enum_tostring(const char *enumtype, int val) const
~StopExecMessage()
Destructor.
virtual Message * clone() const
Clone this message.
virtual bool message_valid(const Message *message) const
Check if message is valid and can be enqueued.
size_t maxlenof_msgid() const
Get maximum length of msgid value.
StopExecMessage()
Constructor.
@ S_INACTIVE
No skill is running.