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

ObstacleMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::ObstacleMessage:

Public Member Functions

 ObstacleMessage (const float ini_x, const float ini_y, const float ini_width)
 Constructor with initial values. More...
 
 ObstacleMessage ()
 Constructor. More...
 
 ~ObstacleMessage ()
 Destructor. More...
 
 ObstacleMessage (const ObstacleMessage *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 width () const
 Get width value. More...
 
void set_width (const float new_width)
 Set width value. More...
 
size_t maxlenof_width () const
 Get maximum length of width 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...
 
Uuid sender_id () const
 Get ID of the immediate sender, not necessarily the creator of the message. More...
 
Uuid source_id () const
 Get ID of the original source of the message. More...
 
void set_sender_id (const Uuid &id)
 Set sender ID. More...
 
void set_source_id (const Uuid &id)
 Set source ID. 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...
 
virtual Messageclone () const
 Clone this message. 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...
 
template<class FieldT , class DataT >
void set_field (FieldT &field, DataT &data)
 Set a field. More...
 
template<class FieldT , class DataT >
void set_field (FieldT &field, unsigned int index, DataT &data)
 Set an array field at a given index. 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

◆ ObstacleMessage() [1/3]

fawkes::NavigatorInterface::ObstacleMessage::ObstacleMessage ( const float  ini_x,
const float  ini_y,
const float  ini_width 
)

◆ ObstacleMessage() [2/3]

◆ ~ObstacleMessage()

fawkes::NavigatorInterface::ObstacleMessage::~ObstacleMessage ( )

Destructor.

Definition at line 2457 of file NavigatorInterface.cpp.

References fawkes::Interface::data_ptr.

◆ ObstacleMessage() [3/3]

fawkes::NavigatorInterface::ObstacleMessage::ObstacleMessage ( const ObstacleMessage m)
explicit

Copy constructor.

Parameters
mmessage to copy from

Definition at line 2465 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::ObstacleMessage::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 2571 of file NavigatorInterface.cpp.

◆ maxlenof_width()

size_t fawkes::NavigatorInterface::ObstacleMessage::maxlenof_width ( ) const

Get maximum length of width value.

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

Definition at line 2550 of file NavigatorInterface.cpp.

◆ maxlenof_x()

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

◆ maxlenof_y()

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

◆ set_width()

void fawkes::NavigatorInterface::ObstacleMessage::set_width ( const float  new_width)

Set width value.

Width of the obstacle.

Parameters
new_widthnew width value

Definition at line 2560 of file NavigatorInterface.cpp.

References fawkes::Interface::set_field().

◆ set_x()

void fawkes::NavigatorInterface::ObstacleMessage::set_x ( const float  new_x)

Set x value.

X-coordinate of the obstacle.

Parameters
new_xnew x value

Definition at line 2500 of file NavigatorInterface.cpp.

References fawkes::Interface::set_field().

◆ set_y()

void fawkes::NavigatorInterface::ObstacleMessage::set_y ( const float  new_y)

Set y value.

Y-coordinate of the obstacle.

Parameters
new_ynew y value

Definition at line 2530 of file NavigatorInterface.cpp.

References fawkes::Interface::set_field().

◆ width()

float fawkes::NavigatorInterface::ObstacleMessage::width ( ) const

Get width value.

Width of the obstacle.

Returns
width value

Definition at line 2540 of file NavigatorInterface.cpp.

◆ x()

float fawkes::NavigatorInterface::ObstacleMessage::x ( ) const

Get x value.

X-coordinate of the obstacle.

Returns
x value

Definition at line 2480 of file NavigatorInterface.cpp.

◆ y()

float fawkes::NavigatorInterface::ObstacleMessage::y ( ) const

Get y value.

Y-coordinate of the obstacle.

Returns
y value

Definition at line 2510 of file NavigatorInterface.cpp.


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