Fawkes API  Fawkes Development Version
fawkes::JoystickInterface::StartRumbleMessage Class Reference

StartRumbleMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::JoystickInterface::StartRumbleMessage:

List of all members.

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 Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

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

Parameters:
mmessage 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.


Member Function Documentation

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.

Returns:
clone of this 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.

Returns:
delay value

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

Returns:
direction value

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.

Returns:
length value

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.

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

Definition at line 564 of file JoystickInterface.cpp.

size_t fawkes::JoystickInterface::StartRumbleMessage::maxlenof_direction ( ) const

Get maximum length of direction value.

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

Definition at line 594 of file JoystickInterface.cpp.

size_t fawkes::JoystickInterface::StartRumbleMessage::maxlenof_length ( ) const

Get maximum length of length value.

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

Definition at line 532 of file JoystickInterface.cpp.

size_t fawkes::JoystickInterface::StartRumbleMessage::maxlenof_strong_magnitude ( ) const

Get maximum length of strong_magnitude value.

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

Definition at line 624 of file JoystickInterface.cpp.

size_t fawkes::JoystickInterface::StartRumbleMessage::maxlenof_weak_magnitude ( ) const

Get maximum length of weak_magnitude value.

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

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.

Parameters:
new_delaynew 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

Parameters:
new_directionnew 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.

Parameters:
new_lengthnew 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.

Parameters:
new_strong_magnitudenew 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.

Parameters:
new_weak_magnitudenew 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.

Returns:
strong_magnitude value

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.

Returns:
weak_magnitude value

Definition at line 644 of file JoystickInterface.cpp.

Referenced by JoystickActThread::MessageProcessor::process_message().


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