Fawkes API  Fawkes Development Version
fawkes::MotorInterface::TransMessage Class Reference

TransMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::TransMessage:

Public Member Functions

 TransMessage (const float ini_vx, const float ini_vy)
 Constructor with initial values. More...
 
 TransMessage ()
 Constructor. More...
 
 ~TransMessage ()
 Destructor. More...
 
 TransMessage (const TransMessage *m)
 Copy constructor. More...
 
float vx () const
 Get vx value. More...
 
void set_vx (const float new_vx)
 Set vx value. More...
 
size_t maxlenof_vx () const
 Get maximum length of vx value. More...
 
float vy () const
 Get vy value. More...
 
void set_vy (const float new_vy)
 Set vy value. More...
 
size_t maxlenof_vy () const
 Get maximum length of vy 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

TransMessage Fawkes BlackBoard Interface Message.

Definition at line 300 of file MotorInterface.h.

Constructor & Destructor Documentation

◆ TransMessage() [1/3]

fawkes::MotorInterface::TransMessage::TransMessage ( const float  ini_vx,
const float  ini_vy 
)

Constructor with initial values.

Parameters
ini_vxinitial value for vx
ini_vyinitial value for vy

Definition at line 1559 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.

◆ TransMessage() [2/3]

fawkes::MotorInterface::TransMessage::TransMessage ( )

◆ ~TransMessage()

fawkes::MotorInterface::TransMessage::~TransMessage ( )

Destructor.

Definition at line 1584 of file MotorInterface.cpp.

References fawkes::Message::data_ptr.

◆ TransMessage() [3/3]

fawkes::MotorInterface::TransMessage::TransMessage ( const TransMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1592 of file MotorInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::MotorInterface::TransMessage::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 1668 of file MotorInterface.cpp.

◆ maxlenof_vx()

size_t fawkes::MotorInterface::TransMessage::maxlenof_vx ( ) const

Get maximum length of vx value.

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

Definition at line 1617 of file MotorInterface.cpp.

◆ maxlenof_vy()

size_t fawkes::MotorInterface::TransMessage::maxlenof_vy ( ) const

Get maximum length of vy value.

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

Definition at line 1647 of file MotorInterface.cpp.

◆ set_vx()

void fawkes::MotorInterface::TransMessage::set_vx ( const float  new_vx)

Set vx value.

Speed in X direction in m/s.

Parameters
new_vxnew vx value

Definition at line 1627 of file MotorInterface.cpp.

◆ set_vy()

void fawkes::MotorInterface::TransMessage::set_vy ( const float  new_vy)

Set vy value.

Speed in Y direction in m/s.

Parameters
new_vynew vy value

Definition at line 1657 of file MotorInterface.cpp.

◆ vx()

float fawkes::MotorInterface::TransMessage::vx ( ) const

Get vx value.

Speed in X direction in m/s.

Returns
vx value

Definition at line 1607 of file MotorInterface.cpp.

◆ vy()

float fawkes::MotorInterface::TransMessage::vy ( ) const

Get vy value.

Speed in Y direction in m/s.

Returns
vy value

Definition at line 1637 of file MotorInterface.cpp.


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