Fawkes API  Fawkes Development Version
fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage Class Reference

AddPointOfInterestMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage:

Public Member Functions

 AddPointOfInterestMessage (const char *ini_name, const float ini_x, const float ini_y, const ConnectionMode ini_mode)
 Constructor with initial values. More...
 
 AddPointOfInterestMessage ()
 Constructor. More...
 
 ~AddPointOfInterestMessage ()
 Destructor. More...
 
 AddPointOfInterestMessage (const AddPointOfInterestMessage *m)
 Copy constructor. More...
 
char * name () const
 Get name value. More...
 
void set_name (const char *new_name)
 Set name value. More...
 
size_t maxlenof_name () const
 Get maximum length of name value. 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...
 
ConnectionMode mode () const
 Get mode value. More...
 
void set_mode (const ConnectionMode new_mode)
 Set mode value. More...
 
size_t maxlenof_mode () const
 Get maximum length of mode 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

◆ AddPointOfInterestMessage() [1/3]

◆ AddPointOfInterestMessage() [2/3]

◆ ~AddPointOfInterestMessage()

fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::~AddPointOfInterestMessage ( )

Destructor.

Definition at line 1386 of file NavGraphGeneratorInterface.cpp.

References fawkes::Message::data_ptr.

◆ AddPointOfInterestMessage() [3/3]

fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::AddPointOfInterestMessage ( const AddPointOfInterestMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1394 of file NavGraphGeneratorInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::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 1538 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_mode()

size_t fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::maxlenof_mode ( ) const

Get maximum length of mode value.

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

Definition at line 1515 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_name()

size_t fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::maxlenof_name ( ) const

Get maximum length of name value.

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

Definition at line 1421 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_x()

size_t fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::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 1453 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_y()

size_t fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::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 1483 of file NavGraphGeneratorInterface.cpp.

◆ mode()

NavGraphGeneratorInterface::ConnectionMode fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::mode ( ) const

Get mode value.

The connection mode to use to connect the POI with the graph.

Returns
mode value

Definition at line 1505 of file NavGraphGeneratorInterface.cpp.

Referenced by NavGraphGeneratorThread::loop().

◆ name()

char * fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::name ( ) const

Get name value.

ID of the obstacle. Can later be used to remove it again.

Returns
name value

Definition at line 1411 of file NavGraphGeneratorInterface.cpp.

Referenced by NavGraphGeneratorThread::loop().

◆ set_mode()

void fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::set_mode ( const ConnectionMode  new_mode)

Set mode value.

The connection mode to use to connect the POI with the graph.

Parameters
new_modenew mode value

Definition at line 1527 of file NavGraphGeneratorInterface.cpp.

◆ set_name()

void fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::set_name ( const char *  new_name)

Set name value.

ID of the obstacle. Can later be used to remove it again.

Parameters
new_namenew name value

Definition at line 1433 of file NavGraphGeneratorInterface.cpp.

◆ set_x()

void fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::set_x ( const float  new_x)

Set x value.

X coordinate of obstacle in global frame.

Parameters
new_xnew x value

Definition at line 1463 of file NavGraphGeneratorInterface.cpp.

◆ set_y()

void fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::set_y ( const float  new_y)

Set y value.

Y coordinate of obstacle in global frame.

Parameters
new_ynew y value

Definition at line 1493 of file NavGraphGeneratorInterface.cpp.

◆ x()

float fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::x ( ) const

Get x value.

X coordinate of obstacle in global frame.

Returns
x value

Definition at line 1443 of file NavGraphGeneratorInterface.cpp.

Referenced by NavGraphGeneratorThread::loop().

◆ y()

float fawkes::NavGraphGeneratorInterface::AddPointOfInterestMessage::y ( ) const

Get y value.

Y coordinate of obstacle in global frame.

Returns
y value

Definition at line 1473 of file NavGraphGeneratorInterface.cpp.

Referenced by NavGraphGeneratorThread::loop().


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