Fawkes API
Fawkes Development Version
|
OpenRaveInterface Fawkes BlackBoard Interface. More...
#include <>>
Classes | |
class | AddObjectMessage |
AddObjectMessage Fawkes BlackBoard Interface Message. More... | |
class | AttachObjectMessage |
AttachObjectMessage Fawkes BlackBoard Interface Message. More... | |
class | DeleteObjectMessage |
DeleteObjectMessage Fawkes BlackBoard Interface Message. More... | |
class | MoveObjectMessage |
MoveObjectMessage Fawkes BlackBoard Interface Message. More... | |
struct | OpenRaveInterface_data_t |
Internal data storage, do NOT modify! More... | |
class | ReleaseAllObjectsMessage |
ReleaseAllObjectsMessage Fawkes BlackBoard Interface Message. More... | |
class | ReleaseObjectMessage |
ReleaseObjectMessage Fawkes BlackBoard Interface Message. More... | |
class | RenameObjectMessage |
RenameObjectMessage Fawkes BlackBoard Interface Message. More... | |
class | RotateObjectMessage |
RotateObjectMessage Fawkes BlackBoard Interface Message. More... | |
class | RotateObjectQuatMessage |
RotateObjectQuatMessage Fawkes BlackBoard Interface Message. More... | |
Public Member Functions | |
virtual bool | message_valid (const Message *message) const |
Check if message is valid and can be enqueued. | |
uint32_t | msgid () const |
Get msgid value. | |
void | set_msgid (const uint32_t new_msgid) |
Set msgid value. | |
size_t | maxlenof_msgid () const |
Get maximum length of msgid value. | |
bool | is_final () const |
Get final value. | |
void | set_final (const bool new_final) |
Set final value. | |
size_t | maxlenof_final () const |
Get maximum length of final value. | |
uint32_t | error_code () const |
Get error_code value. | |
void | set_error_code (const uint32_t new_error_code) |
Set error_code value. | |
size_t | maxlenof_error_code () const |
Get maximum length of error_code value. | |
bool | is_success () const |
Get success value. | |
void | set_success (const bool new_success) |
Set success value. | |
size_t | maxlenof_success () const |
Get maximum length of success value. | |
virtual Message * | create_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. |
OpenRaveInterface Fawkes BlackBoard Interface.
Interface providing access to OpenRAVE functionality
void fawkes::OpenRaveInterface::copy_values | ( | const Interface * | other | ) | [virtual] |
Copy values from other interface.
other | other interface to copy values from |
Implements fawkes::Interface.
Definition at line 239 of file OpenRaveInterface.cpp.
References fawkes::Interface::type().
Message * fawkes::OpenRaveInterface::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.
type | message type |
UnknownTypeException | thrown if this interface cannot create a message of the given type. |
Implements fawkes::Interface.
Definition at line 208 of file OpenRaveInterface.cpp.
const char * fawkes::OpenRaveInterface::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.
enumtype | enum type as string |
val | value to convert |
UnknownTypeException | thrown if enumtype is not specified for interface. |
Implements fawkes::Interface.
Definition at line 250 of file OpenRaveInterface.cpp.
uint32_t fawkes::OpenRaveInterface::error_code | ( | ) | const |
Get error_code value.
Failure code set if final is true. 0 if no error occured, an error code from ERROR_* constants otherwise (or a bit-wise combination).
Definition at line 147 of file OpenRaveInterface.cpp.
References fawkes::OpenRaveInterface::OpenRaveInterface_data_t::error_code.
bool fawkes::OpenRaveInterface::is_final | ( | ) | const |
Get final value.
True, if the last goto command has been finished, false if it is still running
Definition at line 113 of file OpenRaveInterface.cpp.
References fawkes::OpenRaveInterface::OpenRaveInterface_data_t::final.
bool fawkes::OpenRaveInterface::is_success | ( | ) | const |
Get success value.
True, if last command was successful. False otherwise
Definition at line 180 of file OpenRaveInterface.cpp.
References fawkes::OpenRaveInterface::OpenRaveInterface_data_t::success.
size_t fawkes::OpenRaveInterface::maxlenof_error_code | ( | ) | const |
Get maximum length of error_code value.
Definition at line 157 of file OpenRaveInterface.cpp.
size_t fawkes::OpenRaveInterface::maxlenof_final | ( | ) | const |
Get maximum length of final value.
Definition at line 123 of file OpenRaveInterface.cpp.
size_t fawkes::OpenRaveInterface::maxlenof_msgid | ( | ) | const |
Get maximum length of msgid value.
Definition at line 90 of file OpenRaveInterface.cpp.
size_t fawkes::OpenRaveInterface::maxlenof_success | ( | ) | const |
Get maximum length of success value.
Definition at line 190 of file OpenRaveInterface.cpp.
bool fawkes::OpenRaveInterface::message_valid | ( | const Message * | message | ) | const [virtual] |
Check if message is valid and can be enqueued.
message | Message to check |
Implements fawkes::Interface.
Definition at line 1435 of file OpenRaveInterface.cpp.
uint32_t fawkes::OpenRaveInterface::msgid | ( | ) | const |
Get msgid value.
The ID of the message that is currently being processed, or 0 if no message is being processed.
Definition at line 80 of file OpenRaveInterface.cpp.
References fawkes::OpenRaveInterface::OpenRaveInterface_data_t::msgid.
void fawkes::OpenRaveInterface::set_error_code | ( | const uint32_t | new_error_code | ) |
Set error_code value.
Failure code set if final is true. 0 if no error occured, an error code from ERROR_* constants otherwise (or a bit-wise combination).
new_error_code | new error_code value |
Definition at line 169 of file OpenRaveInterface.cpp.
References fawkes::OpenRaveInterface::OpenRaveInterface_data_t::error_code, and fawkes::Interface::data_changed.
void fawkes::OpenRaveInterface::set_final | ( | const bool | new_final | ) |
Set final value.
True, if the last goto command has been finished, false if it is still running
new_final | new final value |
Definition at line 134 of file OpenRaveInterface.cpp.
References fawkes::OpenRaveInterface::OpenRaveInterface_data_t::final, and fawkes::Interface::data_changed.
Referenced by OpenRaveMessageHandlerThread::loop().
void fawkes::OpenRaveInterface::set_msgid | ( | const uint32_t | new_msgid | ) |
Set msgid value.
The ID of the message that is currently being processed, or 0 if no message is being processed.
new_msgid | new msgid value |
Definition at line 101 of file OpenRaveInterface.cpp.
References fawkes::OpenRaveInterface::OpenRaveInterface_data_t::msgid, and fawkes::Interface::data_changed.
Referenced by OpenRaveMessageHandlerThread::loop().
void fawkes::OpenRaveInterface::set_success | ( | const bool | new_success | ) |
Set success value.
True, if last command was successful. False otherwise
new_success | new success value |
Definition at line 200 of file OpenRaveInterface.cpp.
References fawkes::OpenRaveInterface::OpenRaveInterface_data_t::success, and fawkes::Interface::data_changed.
Referenced by OpenRaveMessageHandlerThread::loop().