Fawkes API
Fawkes Development Version
|
TurnMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
TurnMessage (const float ini_angle, const float ini_velocity) | |
Constructor with initial values. More... | |
TurnMessage () | |
Constructor. More... | |
~TurnMessage () | |
Destructor. More... | |
TurnMessage (const TurnMessage *m) | |
Copy constructor. More... | |
float | angle () const |
Get angle value. More... | |
void | set_angle (const float new_angle) |
Set angle value. More... | |
size_t | maxlenof_angle () const |
Get maximum length of angle value. More... | |
float | velocity () const |
Get velocity value. More... | |
void | set_velocity (const float new_velocity) |
Set velocity value. More... | |
size_t | maxlenof_velocity () const |
Get maximum length of velocity value. More... | |
virtual Message * | clone () const |
Clone this message. More... | |
![]() | |
Message (const char *type) | |
Constructor. More... | |
Message (const Message *mesg) | |
Copy constructor. More... | |
Message (const Message &mesg) | |
Copy constructor. More... | |
virtual | ~Message () |
Destructor. More... | |
Message & | operator= (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 Time * | time_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... | |
Interface * | interface () 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... | |
![]() | |
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 | |
![]() | |
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... | |
![]() | |
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_t * | data_ts |
data timestamp aliasing pointer More... | |
TurnMessage Fawkes BlackBoard Interface Message.
Definition at line 131 of file NavigatorInterface.h.
fawkes::NavigatorInterface::TurnMessage::TurnMessage | ( | const float | ini_angle, |
const float | ini_velocity | ||
) |
Constructor with initial values.
ini_angle | initial value for angle |
ini_velocity | initial value for velocity |
Definition at line 875 of file NavigatorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::NavigatorInterface::AllowBackward, fawkes::NavigatorInterface::Backward, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::NavigatorInterface::ESCAPE, fawkes::NavigatorInterface::Forward, fawkes::IFT_FLOAT, fawkes::NavigatorInterface::MovingNotAllowed, fawkes::NavigatorInterface::OrientAtTarget, and fawkes::NavigatorInterface::OrientDuringTravel.
fawkes::NavigatorInterface::TurnMessage::TurnMessage | ( | ) |
Constructor.
Definition at line 895 of file NavigatorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::NavigatorInterface::AllowBackward, fawkes::NavigatorInterface::Backward, fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::NavigatorInterface::ESCAPE, fawkes::NavigatorInterface::Forward, fawkes::IFT_FLOAT, fawkes::NavigatorInterface::MovingNotAllowed, fawkes::NavigatorInterface::OrientAtTarget, and fawkes::NavigatorInterface::OrientDuringTravel.
fawkes::NavigatorInterface::TurnMessage::~TurnMessage | ( | ) |
Destructor.
Definition at line 914 of file NavigatorInterface.cpp.
References fawkes::Message::data_ptr.
fawkes::NavigatorInterface::TurnMessage::TurnMessage | ( | const TurnMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 922 of file NavigatorInterface.cpp.
References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.
float fawkes::NavigatorInterface::TurnMessage::angle | ( | ) | const |
Get angle value.
Angle of the turn.
Definition at line 937 of file NavigatorInterface.cpp.
|
virtual |
Clone this message.
Produces a message of the same type as this message and copies the data to the new message.
Reimplemented from fawkes::Message.
Definition at line 1000 of file NavigatorInterface.cpp.
size_t fawkes::NavigatorInterface::TurnMessage::maxlenof_angle | ( | ) | const |
Get maximum length of angle value.
Definition at line 947 of file NavigatorInterface.cpp.
size_t fawkes::NavigatorInterface::TurnMessage::maxlenof_velocity | ( | ) | const |
Get maximum length of velocity value.
Definition at line 978 of file NavigatorInterface.cpp.
void fawkes::NavigatorInterface::TurnMessage::set_angle | ( | const float | new_angle | ) |
Set angle value.
Angle of the turn.
new_angle | new angle value |
Definition at line 957 of file NavigatorInterface.cpp.
void fawkes::NavigatorInterface::TurnMessage::set_velocity | ( | const float | new_velocity | ) |
Set velocity value.
The desired turning velocity in rad/s, set to zero to use default value.
new_velocity | new velocity value |
Definition at line 989 of file NavigatorInterface.cpp.
float fawkes::NavigatorInterface::TurnMessage::velocity | ( | ) | const |
Get velocity value.
The desired turning velocity in rad/s, set to zero to use default value.
Definition at line 968 of file NavigatorInterface.cpp.