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

StartRumbleMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::JoystickInterface::StartRumbleMessage:

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. More...
 
 StartRumbleMessage ()
 Constructor. More...
 
 ~StartRumbleMessage ()
 Destructor. More...
 
 StartRumbleMessage (const StartRumbleMessage *m)
 Copy constructor. More...
 
uint16_t length () const
 Get length value. More...
 
void set_length (const uint16_t new_length)
 Set length value. More...
 
size_t maxlenof_length () const
 Get maximum length of length value. More...
 
uint16_t delay () const
 Get delay value. More...
 
void set_delay (const uint16_t new_delay)
 Set delay value. More...
 
size_t maxlenof_delay () const
 Get maximum length of delay value. More...
 
Direction direction () const
 Get direction value. More...
 
void set_direction (const Direction new_direction)
 Set direction value. More...
 
size_t maxlenof_direction () const
 Get maximum length of direction value. More...
 
uint16_t strong_magnitude () const
 Get strong_magnitude value. More...
 
void set_strong_magnitude (const uint16_t new_strong_magnitude)
 Set strong_magnitude value. More...
 
size_t maxlenof_strong_magnitude () const
 Get maximum length of strong_magnitude value. More...
 
uint16_t weak_magnitude () const
 Get weak_magnitude value. More...
 
void set_weak_magnitude (const uint16_t new_weak_magnitude)
 Set weak_magnitude value. More...
 
size_t maxlenof_weak_magnitude () const
 Get maximum length of weak_magnitude 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

Constructor & Destructor Documentation

◆ StartRumbleMessage() [1/3]

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.

Parameters
ini_lengthinitial value for length
ini_delayinitial value for delay
ini_directioninitial value for direction
ini_strong_magnitudeinitial value for strong_magnitude
ini_weak_magnitudeinitial value for weak_magnitude

Definition at line 469 of file JoystickInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::JoystickInterface::DIRECTION_DOWN, fawkes::JoystickInterface::DIRECTION_LEFT, fawkes::JoystickInterface::DIRECTION_RIGHT, fawkes::JoystickInterface::DIRECTION_UP, fawkes::IFT_ENUM, and fawkes::IFT_UINT16.

◆ StartRumbleMessage() [2/3]

◆ ~StartRumbleMessage()

fawkes::JoystickInterface::StartRumbleMessage::~StartRumbleMessage ( )

Destructor.

Definition at line 511 of file JoystickInterface.cpp.

References fawkes::Message::data_ptr.

◆ StartRumbleMessage() [3/3]

fawkes::JoystickInterface::StartRumbleMessage::StartRumbleMessage ( const StartRumbleMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 519 of file JoystickInterface.cpp.

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

Member Function Documentation

◆ clone()

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 689 of file JoystickInterface.cpp.

◆ delay()

uint16_t fawkes::JoystickInterface::StartRumbleMessage::delay ( ) const

Get delay value.

Delay before effect starts in ms.

Returns
delay value

Definition at line 568 of file JoystickInterface.cpp.

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

◆ direction()

JoystickInterface::Direction fawkes::JoystickInterface::StartRumbleMessage::direction ( ) const

Get direction value.

Direction of effect

Returns
direction value

Definition at line 598 of file JoystickInterface.cpp.

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

◆ length()

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 536 of file JoystickInterface.cpp.

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

◆ maxlenof_delay()

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 578 of file JoystickInterface.cpp.

◆ maxlenof_direction()

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 608 of file JoystickInterface.cpp.

◆ maxlenof_length()

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 546 of file JoystickInterface.cpp.

◆ maxlenof_strong_magnitude()

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 638 of file JoystickInterface.cpp.

◆ maxlenof_weak_magnitude()

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 668 of file JoystickInterface.cpp.

◆ set_delay()

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 588 of file JoystickInterface.cpp.

◆ set_direction()

void fawkes::JoystickInterface::StartRumbleMessage::set_direction ( const Direction  new_direction)

Set direction value.

Direction of effect

Parameters
new_directionnew direction value

Definition at line 618 of file JoystickInterface.cpp.

◆ set_length()

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 558 of file JoystickInterface.cpp.

Referenced by JoystickTeleOpThread::init().

◆ set_strong_magnitude()

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 648 of file JoystickInterface.cpp.

Referenced by JoystickTeleOpThread::init(), RoombaJoystickThread::loop(), and JoystickTeleOpThread::loop().

◆ set_weak_magnitude()

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 678 of file JoystickInterface.cpp.

Referenced by JoystickTeleOpThread::init(), RoombaJoystickThread::loop(), and JoystickTeleOpThread::loop().

◆ strong_magnitude()

uint16_t fawkes::JoystickInterface::StartRumbleMessage::strong_magnitude ( ) const

Get strong_magnitude value.

Magnitude of heavy motor.

Returns
strong_magnitude value

Definition at line 628 of file JoystickInterface.cpp.

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

◆ weak_magnitude()

uint16_t fawkes::JoystickInterface::StartRumbleMessage::weak_magnitude ( ) const

Get weak_magnitude value.

Magnitude of light motor.

Returns
weak_magnitude value

Definition at line 658 of file JoystickInterface.cpp.

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


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