Fawkes API  Fawkes Development Version
fawkes::OpenRaveInterface Class Reference

OpenRaveInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::OpenRaveInterface:

Classes

class  AddObjectMessage
 AddObjectMessage Fawkes BlackBoard Interface Message. More...
 
class  AttachObjectMessage
 AttachObjectMessage Fawkes BlackBoard Interface Message. More...
 
class  DeleteAllObjectsMessage
 DeleteAllObjectsMessage Fawkes BlackBoard Interface Message. More...
 
class  DeleteObjectMessage
 DeleteObjectMessage Fawkes BlackBoard Interface Message. More...
 
class  MoveObjectMessage
 MoveObjectMessage Fawkes BlackBoard Interface Message. 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...
 
class  StartViewerMessage
 StartViewerMessage 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. More...
 
uint32_t msgid () const
 Get msgid value. More...
 
void set_msgid (const uint32_t new_msgid)
 Set msgid value. More...
 
size_t maxlenof_msgid () const
 Get maximum length of msgid value. More...
 
bool is_final () const
 Get final value. More...
 
void set_final (const bool new_final)
 Set final value. More...
 
size_t maxlenof_final () const
 Get maximum length of final value. More...
 
uint32_t error_code () const
 Get error_code value. More...
 
void set_error_code (const uint32_t new_error_code)
 Set error_code value. More...
 
size_t maxlenof_error_code () const
 Get maximum length of error_code value. More...
 
bool is_success () const
 Get success value. More...
 
void set_success (const bool new_success)
 Set success value. More...
 
size_t maxlenof_success () const
 Get maximum length of success value. More...
 
virtual Messagecreate_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...
 
- Public Member Functions inherited from fawkes::Interface
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 Timetimestamp () 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...
 
Messagemsgq_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 Public Member Functions inherited from fawkes::Interface
static void parse_uid (const char *uid, std::string &type, std::string &id)
 Parse UID to type and ID strings. More...
 
- Protected Member Functions inherited from fawkes::Interface
 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...
 
- Protected Attributes inherited from fawkes::Interface
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_tdata_ts
 Pointer to data casted to timestamp struct. More...
 

Detailed Description

OpenRaveInterface Fawkes BlackBoard Interface.

Interface providing access to OpenRAVE functionality

Definition at line 33 of file OpenRaveInterface.h.

Member Function Documentation

◆ copy_values()

void fawkes::OpenRaveInterface::copy_values ( const Interface other)
virtual

Copy values from other interface.

Parameters
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 247 of file OpenRaveInterface.cpp.

References fawkes::Interface::type().

◆ create_message()

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.

Parameters
typemessage type
Returns
message of the given type, empty
Exceptions
UnknownTypeExceptionthrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 212 of file OpenRaveInterface.cpp.

◆ enum_tostring()

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.

Parameters
enumtypeenum type as string
valvalue to convert
Returns
string representation of value
Exceptions
UnknownTypeExceptionthrown if enumtype is not specified for interface.

Implements fawkes::Interface.

Definition at line 258 of file OpenRaveInterface.cpp.

◆ error_code()

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).

Returns
error_code value

Definition at line 151 of file OpenRaveInterface.cpp.

◆ is_final()

bool fawkes::OpenRaveInterface::is_final ( ) const

Get final value.

True, if the last goto command has been finished, false if it is still running

Returns
final value

Definition at line 117 of file OpenRaveInterface.cpp.

◆ is_success()

bool fawkes::OpenRaveInterface::is_success ( ) const

Get success value.

True, if last command was successful. False otherwise

Returns
success value

Definition at line 184 of file OpenRaveInterface.cpp.

◆ maxlenof_error_code()

size_t fawkes::OpenRaveInterface::maxlenof_error_code ( ) const

Get maximum length of error_code value.

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

Definition at line 161 of file OpenRaveInterface.cpp.

◆ maxlenof_final()

size_t fawkes::OpenRaveInterface::maxlenof_final ( ) const

Get maximum length of final value.

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

Definition at line 127 of file OpenRaveInterface.cpp.

◆ maxlenof_msgid()

size_t fawkes::OpenRaveInterface::maxlenof_msgid ( ) const

Get maximum length of msgid value.

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

Definition at line 94 of file OpenRaveInterface.cpp.

◆ maxlenof_success()

size_t fawkes::OpenRaveInterface::maxlenof_success ( ) const

Get maximum length of success value.

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

Definition at line 194 of file OpenRaveInterface.cpp.

◆ message_valid()

bool fawkes::OpenRaveInterface::message_valid ( const Message message) const
virtual

Check if message is valid and can be enqueued.

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

Implements fawkes::Interface.

Definition at line 1570 of file OpenRaveInterface.cpp.

◆ msgid()

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.

Returns
msgid value

Definition at line 84 of file OpenRaveInterface.cpp.

◆ set_error_code()

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).

Parameters
new_error_codenew error_code value

Definition at line 173 of file OpenRaveInterface.cpp.

◆ set_final()

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

Parameters
new_finalnew final value

Definition at line 138 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

◆ set_msgid()

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.

Parameters
new_msgidnew msgid value

Definition at line 105 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().

◆ set_success()

void fawkes::OpenRaveInterface::set_success ( const bool  new_success)

Set success value.

True, if last command was successful. False otherwise

Parameters
new_successnew success value

Definition at line 204 of file OpenRaveInterface.cpp.

Referenced by OpenRaveMessageHandlerThread::loop().


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