Fawkes API  Fawkes Development Version
fawkes::NavigatorInterface::PolarGotoMessage Class Reference

PolarGotoMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::PolarGotoMessage:

Public Member Functions

 PolarGotoMessage (const float ini_phi, const float ini_dist, const float ini_orientation)
 Constructor with initial values. More...
 
 PolarGotoMessage ()
 Constructor. More...
 
 ~PolarGotoMessage ()
 Destructor. More...
 
 PolarGotoMessage (const PolarGotoMessage *m)
 Copy constructor. 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 dist () const
 Get dist value. More...
 
void set_dist (const float new_dist)
 Set dist value. More...
 
size_t maxlenof_dist () const
 Get maximum length of dist value. More...
 
float orientation () const
 Get orientation value. More...
 
void set_orientation (const float new_orientation)
 Set orientation value. More...
 
size_t maxlenof_orientation () const
 Get maximum length of orientation 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

◆ PolarGotoMessage() [1/3]

fawkes::NavigatorInterface::PolarGotoMessage::PolarGotoMessage ( const float  ini_phi,
const float  ini_dist,
const float  ini_orientation 
)

◆ PolarGotoMessage() [2/3]

◆ ~PolarGotoMessage()

fawkes::NavigatorInterface::PolarGotoMessage::~PolarGotoMessage ( )

Destructor.

Definition at line 1230 of file NavigatorInterface.cpp.

References fawkes::Message::data_ptr.

◆ PolarGotoMessage() [3/3]

fawkes::NavigatorInterface::PolarGotoMessage::PolarGotoMessage ( const PolarGotoMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1238 of file NavigatorInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::NavigatorInterface::PolarGotoMessage::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 1344 of file NavigatorInterface.cpp.

◆ dist()

float fawkes::NavigatorInterface::PolarGotoMessage::dist ( ) const

Get dist value.

Distance to the target.

Returns
dist value

Definition at line 1283 of file NavigatorInterface.cpp.

Referenced by ColliActThread::loop().

◆ maxlenof_dist()

size_t fawkes::NavigatorInterface::PolarGotoMessage::maxlenof_dist ( ) const

Get maximum length of dist value.

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

Definition at line 1293 of file NavigatorInterface.cpp.

◆ maxlenof_orientation()

size_t fawkes::NavigatorInterface::PolarGotoMessage::maxlenof_orientation ( ) const

Get maximum length of orientation value.

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

Definition at line 1323 of file NavigatorInterface.cpp.

◆ maxlenof_phi()

size_t fawkes::NavigatorInterface::PolarGotoMessage::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 1263 of file NavigatorInterface.cpp.

◆ orientation()

float fawkes::NavigatorInterface::PolarGotoMessage::orientation ( ) const

Get orientation value.

The desired orientation of the robot at the target.

Returns
orientation value

Definition at line 1313 of file NavigatorInterface.cpp.

Referenced by ColliActThread::loop().

◆ phi()

float fawkes::NavigatorInterface::PolarGotoMessage::phi ( ) const

Get phi value.

Angle between the robot's front and the target.

Returns
phi value

Definition at line 1253 of file NavigatorInterface.cpp.

Referenced by ColliActThread::loop().

◆ set_dist()

void fawkes::NavigatorInterface::PolarGotoMessage::set_dist ( const float  new_dist)

Set dist value.

Distance to the target.

Parameters
new_distnew dist value

Definition at line 1303 of file NavigatorInterface.cpp.

◆ set_orientation()

void fawkes::NavigatorInterface::PolarGotoMessage::set_orientation ( const float  new_orientation)

Set orientation value.

The desired orientation of the robot at the target.

Parameters
new_orientationnew orientation value

Definition at line 1333 of file NavigatorInterface.cpp.

◆ set_phi()

void fawkes::NavigatorInterface::PolarGotoMessage::set_phi ( const float  new_phi)

Set phi value.

Angle between the robot's front and the target.

Parameters
new_phinew phi value

Definition at line 1273 of file NavigatorInterface.cpp.


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