Fawkes API  Fawkes Development Version
fawkes::KatanaInterface::ObjectGotoMessage Class Reference

ObjectGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::KatanaInterface::ObjectGotoMessage:

Public Member Functions

 ObjectGotoMessage (const char *ini_object, const float ini_rot_x)
 Constructor with initial values. More...
 
 ObjectGotoMessage ()
 Constructor. More...
 
 ~ObjectGotoMessage ()
 Destructor. More...
 
 ObjectGotoMessage (const ObjectGotoMessage *m)
 Copy constructor. More...
 
char * object () const
 Get object value. More...
 
void set_object (const char *new_object)
 Set object value. More...
 
size_t maxlenof_object () const
 Get maximum length of object value. More...
 
float rot_x () const
 Get rot_x value. More...
 
void set_rot_x (const float new_rot_x)
 Set rot_x value. More...
 
size_t maxlenof_rot_x () const
 Get maximum length of rot_x value. More...
 
virtual Messageclone () const
 Clone this message. More...
 
- Public Member Functions inherited from fawkes::Message
 Message (const char *type)
 Constructor. More...
 
 Message (const Message *mesg)
 Copy constructor. More...
 
 Message (const Message &mesg)
 Copy constructor. More...
 
virtual ~Message ()
 Destructor. More...
 
Messageoperator= (const Message &m)
 Assign this message to given message. More...
 
unsigned int id () const
 Get message ID. More...
 
void set_id (unsigned int message_id)
 Set message ID. More...
 
void mark_enqueued ()
 Mark message as being enqueued. More...
 
bool enqueued () const
 Check is message has been enqueued. More...
 
const Timetime_enqueued () const
 Get time when message was enqueued. More...
 
unsigned int sender_id () const
 Get ID of sender. More...
 
const char * sender_thread_name () const
 Get sender of message. More...
 
Interfaceinterface () const
 Get transmitting interface. More...
 
const char * type () const
 Get message type. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields () const
 Get the number of fields in the message. More...
 
const void * datachunk () const
 Get pointer to data. More...
 
unsigned int datasize () const
 Get size of data. More...
 
unsigned int hops () const
 Get number of hops. More...
 
void set_hops (unsigned int hops)
 Set number of hops. More...
 
void set_from_chunk (const void *chunk)
 Set from raw data chunk. More...
 
unsigned int recipient () const
 Get recipient memory serial. More...
 
template<class MessageType >
bool is_of_type ()
 Check if message has desired type. More...
 
template<class MessageType >
MessageType * as_type ()
 Cast message to given type if possible. More...
 
- Public Member Functions inherited from fawkes::RefCount
 RefCount ()
 Constructor. More...
 
virtual ~RefCount ()
 Destructor. More...
 
void ref ()
 Increment reference count. More...
 
void unref ()
 Decrement reference count and conditionally delete this instance. More...
 
unsigned int refcount ()
 Get reference count for this instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Message
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 info list. More...
 
- Protected Attributes inherited from fawkes::Message
void * data_ptr
 Pointer to memory that contains local data. More...
 
unsigned int data_size
 Size of memory needed to hold all data. More...
 
message_data_ts_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

ObjectGotoMessage Fawkes BlackBoard Interface Message.

Definition at line 277 of file KatanaInterface.h.

Constructor & Destructor Documentation

◆ ObjectGotoMessage() [1/3]

fawkes::KatanaInterface::ObjectGotoMessage::ObjectGotoMessage ( const char *  ini_object,
const float  ini_rot_x 
)

Constructor with initial values.

Parameters
ini_objectinitial value for object
ini_rot_xinitial value for rot_x

Definition at line 1662 of file KatanaInterface.cpp.

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

◆ ObjectGotoMessage() [2/3]

fawkes::KatanaInterface::ObjectGotoMessage::ObjectGotoMessage ( )

◆ ~ObjectGotoMessage()

fawkes::KatanaInterface::ObjectGotoMessage::~ObjectGotoMessage ( )

Destructor.

Definition at line 1687 of file KatanaInterface.cpp.

References fawkes::Message::data_ptr.

◆ ObjectGotoMessage() [3/3]

fawkes::KatanaInterface::ObjectGotoMessage::ObjectGotoMessage ( const ObjectGotoMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1695 of file KatanaInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::KatanaInterface::ObjectGotoMessage::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 1771 of file KatanaInterface.cpp.

◆ maxlenof_object()

size_t fawkes::KatanaInterface::ObjectGotoMessage::maxlenof_object ( ) const

Get maximum length of object value.

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

Definition at line 1720 of file KatanaInterface.cpp.

◆ maxlenof_rot_x()

size_t fawkes::KatanaInterface::ObjectGotoMessage::maxlenof_rot_x ( ) const

Get maximum length of rot_x value.

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

Definition at line 1750 of file KatanaInterface.cpp.

◆ object()

char * fawkes::KatanaInterface::ObjectGotoMessage::object ( ) const

Get object value.

Name of object

Returns
object value

Definition at line 1710 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

◆ rot_x()

float fawkes::KatanaInterface::ObjectGotoMessage::rot_x ( ) const

Get rot_x value.

Rotation of object on its x-axis

Returns
rot_x value

Definition at line 1740 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

◆ set_object()

void fawkes::KatanaInterface::ObjectGotoMessage::set_object ( const char *  new_object)

Set object value.

Name of object

Parameters
new_objectnew object value

Definition at line 1730 of file KatanaInterface.cpp.

◆ set_rot_x()

void fawkes::KatanaInterface::ObjectGotoMessage::set_rot_x ( const float  new_rot_x)

Set rot_x value.

Rotation of object on its x-axis

Parameters
new_rot_xnew rot_x value

Definition at line 1760 of file KatanaInterface.cpp.


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