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

GotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::GotoMessage:

Public Member Functions

 GotoMessage (const float ini_x, const float ini_y, const float ini_phi, const float ini_time_sec)
 Constructor with initial values. More...
 
 GotoMessage ()
 Constructor. More...
 
 ~GotoMessage ()
 Destructor. More...
 
 GotoMessage (const GotoMessage *m)
 Copy constructor. More...
 
float x () const
 Get x value. More...
 
void set_x (const float new_x)
 Set x value. More...
 
size_t maxlenof_x () const
 Get maximum length of x value. More...
 
float y () const
 Get y value. More...
 
void set_y (const float new_y)
 Set y value. More...
 
size_t maxlenof_y () const
 Get maximum length of y value. More...
 
float phi () const
 Get phi value. More...
 
void set_phi (const float new_phi)
 Set phi value. More...
 
size_t maxlenof_phi () const
 Get maximum length of phi value. More...
 
float time_sec () const
 Get time_sec value. More...
 
void set_time_sec (const float new_time_sec)
 Set time_sec value. More...
 
size_t maxlenof_time_sec () const
 Get maximum length of time_sec 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

GotoMessage Fawkes BlackBoard Interface Message.

Definition at line 263 of file MotorInterface.h.

Constructor & Destructor Documentation

◆ GotoMessage() [1/3]

fawkes::MotorInterface::GotoMessage::GotoMessage ( const float  ini_x,
const float  ini_y,
const float  ini_phi,
const float  ini_time_sec 
)

Constructor with initial values.

Parameters
ini_xinitial value for x
ini_yinitial value for y
ini_phiinitial value for phi
ini_time_secinitial value for time_sec

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

◆ GotoMessage() [2/3]

fawkes::MotorInterface::GotoMessage::GotoMessage ( )

◆ ~GotoMessage()

fawkes::MotorInterface::GotoMessage::~GotoMessage ( )

Destructor.

Definition at line 1400 of file MotorInterface.cpp.

References fawkes::Message::data_ptr.

◆ GotoMessage() [3/3]

fawkes::MotorInterface::GotoMessage::GotoMessage ( const GotoMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1408 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::GotoMessage::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 1544 of file MotorInterface.cpp.

◆ maxlenof_phi()

size_t fawkes::MotorInterface::GotoMessage::maxlenof_phi ( ) const

Get maximum length of phi value.

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

Definition at line 1493 of file MotorInterface.cpp.

◆ maxlenof_time_sec()

size_t fawkes::MotorInterface::GotoMessage::maxlenof_time_sec ( ) const

Get maximum length of time_sec value.

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

Definition at line 1523 of file MotorInterface.cpp.

◆ maxlenof_x()

size_t fawkes::MotorInterface::GotoMessage::maxlenof_x ( ) const

Get maximum length of x value.

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

Definition at line 1433 of file MotorInterface.cpp.

◆ maxlenof_y()

size_t fawkes::MotorInterface::GotoMessage::maxlenof_y ( ) const

Get maximum length of y value.

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

Definition at line 1463 of file MotorInterface.cpp.

◆ phi()

float fawkes::MotorInterface::GotoMessage::phi ( ) const

Get phi value.

Angle relative to current angle in rad.

Returns
phi value

Definition at line 1483 of file MotorInterface.cpp.

Referenced by PlayerMotorPositionMapper::sync_fawkes_to_player().

◆ set_phi()

void fawkes::MotorInterface::GotoMessage::set_phi ( const float  new_phi)

Set phi value.

Angle relative to current angle in rad.

Parameters
new_phinew phi value

Definition at line 1503 of file MotorInterface.cpp.

◆ set_time_sec()

void fawkes::MotorInterface::GotoMessage::set_time_sec ( const float  new_time_sec)

Set time_sec value.

When to reach the desired location.

Parameters
new_time_secnew time_sec value

Definition at line 1533 of file MotorInterface.cpp.

◆ set_x()

void fawkes::MotorInterface::GotoMessage::set_x ( const float  new_x)

Set x value.

X distance in m.

Parameters
new_xnew x value

Definition at line 1443 of file MotorInterface.cpp.

◆ set_y()

void fawkes::MotorInterface::GotoMessage::set_y ( const float  new_y)

Set y value.

Y distance in m.

Parameters
new_ynew y value

Definition at line 1473 of file MotorInterface.cpp.

◆ time_sec()

float fawkes::MotorInterface::GotoMessage::time_sec ( ) const

Get time_sec value.

When to reach the desired location.

Returns
time_sec value

Definition at line 1513 of file MotorInterface.cpp.

◆ x()

float fawkes::MotorInterface::GotoMessage::x ( ) const

Get x value.

X distance in m.

Returns
x value

Definition at line 1423 of file MotorInterface.cpp.

Referenced by PlayerMotorPositionMapper::sync_fawkes_to_player().

◆ y()

float fawkes::MotorInterface::GotoMessage::y ( ) const

Get y value.

Y distance in m.

Returns
y value

Definition at line 1453 of file MotorInterface.cpp.

Referenced by PlayerMotorPositionMapper::sync_fawkes_to_player().


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