Fawkes API
Fawkes Development Version
|
OrbitMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Public Member Functions | |
OrbitMessage (const float ini_px, const float ini_py, const float ini_omega) | |
Constructor with initial values. More... | |
OrbitMessage () | |
Constructor. More... | |
~OrbitMessage () | |
Destructor. More... | |
OrbitMessage (const OrbitMessage *m) | |
Copy constructor. More... | |
float | px () const |
Get px value. More... | |
void | set_px (const float new_px) |
Set px value. More... | |
size_t | maxlenof_px () const |
Get maximum length of px value. More... | |
float | py () const |
Get py value. More... | |
void | set_py (const float new_py) |
Set py value. More... | |
size_t | maxlenof_py () const |
Get maximum length of py value. More... | |
float | omega () const |
Get omega value. More... | |
void | set_omega (const float new_omega) |
Set omega value. More... | |
size_t | maxlenof_omega () const |
Get maximum length of omega 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... | |
OrbitMessage Fawkes BlackBoard Interface Message.
Definition at line 387 of file MotorInterface.h.
fawkes::MotorInterface::OrbitMessage::OrbitMessage | ( | const float | ini_px, |
const float | ini_py, | ||
const float | ini_omega | ||
) |
Constructor with initial values.
ini_px | initial value for px |
ini_py | initial value for py |
ini_omega | initial value for omega |
Definition at line 1932 of file MotorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.
fawkes::MotorInterface::OrbitMessage::OrbitMessage | ( | ) |
Constructor.
Definition at line 1947 of file MotorInterface.cpp.
References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.
fawkes::MotorInterface::OrbitMessage::~OrbitMessage | ( | ) |
Destructor.
Definition at line 1960 of file MotorInterface.cpp.
References fawkes::Message::data_ptr.
fawkes::MotorInterface::OrbitMessage::OrbitMessage | ( | const OrbitMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 1968 of file MotorInterface.cpp.
References fawkes::Message::data_ptr, fawkes::Message::data_size, and fawkes::Message::data_ts.
|
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 2074 of file MotorInterface.cpp.
size_t fawkes::MotorInterface::OrbitMessage::maxlenof_omega | ( | ) | const |
Get maximum length of omega value.
Definition at line 2053 of file MotorInterface.cpp.
size_t fawkes::MotorInterface::OrbitMessage::maxlenof_px | ( | ) | const |
Get maximum length of px value.
Definition at line 1993 of file MotorInterface.cpp.
size_t fawkes::MotorInterface::OrbitMessage::maxlenof_py | ( | ) | const |
Get maximum length of py value.
Definition at line 2023 of file MotorInterface.cpp.
float fawkes::MotorInterface::OrbitMessage::omega | ( | ) | const |
Get omega value.
Angular speed around point in rad/s.
Definition at line 2043 of file MotorInterface.cpp.
float fawkes::MotorInterface::OrbitMessage::px | ( | ) | const |
Get px value.
Point's X coordinate to orbit.
Definition at line 1983 of file MotorInterface.cpp.
float fawkes::MotorInterface::OrbitMessage::py | ( | ) | const |
Get py value.
Point's Y coordinate to orbit.
Definition at line 2013 of file MotorInterface.cpp.
void fawkes::MotorInterface::OrbitMessage::set_omega | ( | const float | new_omega | ) |
Set omega value.
Angular speed around point in rad/s.
new_omega | new omega value |
Definition at line 2063 of file MotorInterface.cpp.
void fawkes::MotorInterface::OrbitMessage::set_px | ( | const float | new_px | ) |
Set px value.
Point's X coordinate to orbit.
new_px | new px value |
Definition at line 2003 of file MotorInterface.cpp.
void fawkes::MotorInterface::OrbitMessage::set_py | ( | const float | new_py | ) |
Set py value.
Point's Y coordinate to orbit.
new_py | new py value |
Definition at line 2033 of file MotorInterface.cpp.