Fawkes API
Fawkes Development Version
|
StartRumbleMessage Fawkes BlackBoard Interface Message. More...
#include <>>
Classes | |
struct | StartRumbleMessage_data_t |
Internal data storage, do NOT modify! More... | |
Public Member Functions | |
StartRumbleMessage (const uint16_t ini_length, const uint16_t ini_delay, const Direction ini_direction, const uint16_t ini_strong_magnitude, const uint16_t ini_weak_magnitude) | |
Constructor with initial values. | |
StartRumbleMessage () | |
Constructor. | |
~StartRumbleMessage () | |
Destructor. | |
StartRumbleMessage (const StartRumbleMessage *m) | |
Copy constructor. | |
uint16_t | length () const |
Get length value. | |
void | set_length (const uint16_t new_length) |
Set length value. | |
size_t | maxlenof_length () const |
Get maximum length of length value. | |
uint16_t | delay () const |
Get delay value. | |
void | set_delay (const uint16_t new_delay) |
Set delay value. | |
size_t | maxlenof_delay () const |
Get maximum length of delay value. | |
Direction | direction () const |
Get direction value. | |
void | set_direction (const Direction new_direction) |
Set direction value. | |
size_t | maxlenof_direction () const |
Get maximum length of direction value. | |
uint16_t | strong_magnitude () const |
Get strong_magnitude value. | |
void | set_strong_magnitude (const uint16_t new_strong_magnitude) |
Set strong_magnitude value. | |
size_t | maxlenof_strong_magnitude () const |
Get maximum length of strong_magnitude value. | |
uint16_t | weak_magnitude () const |
Get weak_magnitude value. | |
void | set_weak_magnitude (const uint16_t new_weak_magnitude) |
Set weak_magnitude value. | |
size_t | maxlenof_weak_magnitude () const |
Get maximum length of weak_magnitude value. | |
virtual Message * | clone () const |
Clone this message. |
StartRumbleMessage Fawkes BlackBoard Interface Message.
fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage | ( | const uint16_t | ini_length, |
const uint16_t | ini_delay, | ||
const Direction | ini_direction, | ||
const uint16_t | ini_strong_magnitude, | ||
const uint16_t | ini_weak_magnitude | ||
) |
Constructor with initial values.
ini_length | initial value for length |
ini_delay | initial value for delay |
ini_direction | initial value for direction |
ini_strong_magnitude | initial value for strong_magnitude |
ini_weak_magnitude | initial value for weak_magnitude |
Definition at line 463 of file JoystickInterface.cpp.
References fawkes::Message::data_size, fawkes::Message::data_ptr, fawkes::Message::data_ts, fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage_data_t::length, fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage_data_t::delay, fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage_data_t::direction, fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage_data_t::strong_magnitude, fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage_data_t::weak_magnitude, fawkes::Message::add_fieldinfo(), fawkes::IFT_UINT16, and fawkes::IFT_ENUM.
fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage | ( | ) |
Constructor.
Definition at line 482 of file JoystickInterface.cpp.
References fawkes::Message::data_size, fawkes::Message::data_ptr, fawkes::Message::data_ts, fawkes::Message::add_fieldinfo(), fawkes::IFT_UINT16, fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage_data_t::length, fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage_data_t::delay, fawkes::IFT_ENUM, fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage_data_t::direction, fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage_data_t::strong_magnitude, and fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage_data_t::weak_magnitude.
fawkes::JoystickInterface::StartRumbleMessage::~StartRumbleMessage | ( | ) |
Destructor.
Definition at line 497 of file JoystickInterface.cpp.
References fawkes::Interface::data_ptr.
fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage | ( | const StartRumbleMessage * | m | ) |
Copy constructor.
m | message to copy from |
Definition at line 505 of file JoystickInterface.cpp.
References fawkes::Message::data_size, fawkes::Message::data_ptr, and fawkes::Message::data_ts.
Message * fawkes::JoystickInterface::StartRumbleMessage::clone | ( | ) | const [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 675 of file JoystickInterface.cpp.
uint16_t fawkes::JoystickInterface::StartRumbleMessage::delay | ( | ) | const |
Get delay value.
Delay before effect starts in ms.
Definition at line 554 of file JoystickInterface.cpp.
Referenced by JoystickActThread::MessageProcessor::process_message().
JoystickInterface::Direction fawkes::JoystickInterface::StartRumbleMessage::direction | ( | ) | const |
Get direction value.
Direction of effect
Definition at line 584 of file JoystickInterface.cpp.
Referenced by JoystickActThread::MessageProcessor::process_message().
uint16_t fawkes::JoystickInterface::StartRumbleMessage::length | ( | ) | const |
Get length value.
Effect length in ms. Setting to 0 will make the effect to play continuously until stopped.
Definition at line 522 of file JoystickInterface.cpp.
Referenced by JoystickActThread::MessageProcessor::process_message().
size_t fawkes::JoystickInterface::StartRumbleMessage::maxlenof_delay | ( | ) | const |
Get maximum length of delay value.
Definition at line 564 of file JoystickInterface.cpp.
size_t fawkes::JoystickInterface::StartRumbleMessage::maxlenof_direction | ( | ) | const |
Get maximum length of direction value.
Definition at line 594 of file JoystickInterface.cpp.
size_t fawkes::JoystickInterface::StartRumbleMessage::maxlenof_length | ( | ) | const |
Get maximum length of length value.
Definition at line 532 of file JoystickInterface.cpp.
size_t fawkes::JoystickInterface::StartRumbleMessage::maxlenof_strong_magnitude | ( | ) | const |
Get maximum length of strong_magnitude value.
Definition at line 624 of file JoystickInterface.cpp.
size_t fawkes::JoystickInterface::StartRumbleMessage::maxlenof_weak_magnitude | ( | ) | const |
Get maximum length of weak_magnitude value.
Definition at line 654 of file JoystickInterface.cpp.
void fawkes::JoystickInterface::StartRumbleMessage::set_delay | ( | const uint16_t | new_delay | ) |
Set delay value.
Delay before effect starts in ms.
new_delay | new delay value |
Definition at line 574 of file JoystickInterface.cpp.
void fawkes::JoystickInterface::StartRumbleMessage::set_direction | ( | const Direction | new_direction | ) |
Set direction value.
Direction of effect
new_direction | new direction value |
Definition at line 604 of file JoystickInterface.cpp.
void fawkes::JoystickInterface::StartRumbleMessage::set_length | ( | const uint16_t | new_length | ) |
Set length value.
Effect length in ms. Setting to 0 will make the effect to play continuously until stopped.
new_length | new length value |
Definition at line 544 of file JoystickInterface.cpp.
void fawkes::JoystickInterface::StartRumbleMessage::set_strong_magnitude | ( | const uint16_t | new_strong_magnitude | ) |
Set strong_magnitude value.
Magnitude of heavy motor.
new_strong_magnitude | new strong_magnitude value |
Definition at line 634 of file JoystickInterface.cpp.
Referenced by RoombaJoystickThread::loop().
void fawkes::JoystickInterface::StartRumbleMessage::set_weak_magnitude | ( | const uint16_t | new_weak_magnitude | ) |
Set weak_magnitude value.
Magnitude of light motor.
new_weak_magnitude | new weak_magnitude value |
Definition at line 664 of file JoystickInterface.cpp.
Referenced by RoombaJoystickThread::loop().
uint16_t fawkes::JoystickInterface::StartRumbleMessage::strong_magnitude | ( | ) | const |
Get strong_magnitude value.
Magnitude of heavy motor.
Definition at line 614 of file JoystickInterface.cpp.
Referenced by JoystickActThread::MessageProcessor::process_message().
uint16_t fawkes::JoystickInterface::StartRumbleMessage::weak_magnitude | ( | ) | const |
Get weak_magnitude value.
Magnitude of light motor.
Definition at line 644 of file JoystickInterface.cpp.
Referenced by JoystickActThread::MessageProcessor::process_message().