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

StopMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::StopMessage:

Public Member Functions

 StopMessage (const uint32_t ini_msgid)
 Constructor with initial values. More...
 
 StopMessage ()
 Constructor. More...
 
 ~StopMessage ()
 Destructor. More...
 
 StopMessage (const StopMessage *m)
 Copy constructor. More...
 
uint32_t msgid () const
 Get msgid value. More...
 
void set_msgid (const uint32_t new_msgid)
 Set msgid value. More...
 
size_t maxlenof_msgid () const
 Get maximum length of msgid 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...
 
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

StopMessage Fawkes BlackBoard Interface Message.

Definition at line 110 of file NavigatorInterface.h.

Constructor & Destructor Documentation

◆ StopMessage() [1/3]

◆ StopMessage() [2/3]

◆ ~StopMessage()

fawkes::NavigatorInterface::StopMessage::~StopMessage ( )

Destructor.

Definition at line 879 of file NavigatorInterface.cpp.

References fawkes::Interface::data_ptr.

◆ StopMessage() [3/3]

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

Copy constructor.

Parameters
mmessage to copy from

Definition at line 887 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::StopMessage::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 949 of file NavigatorInterface.cpp.

◆ maxlenof_msgid()

size_t fawkes::NavigatorInterface::StopMessage::maxlenof_msgid ( ) const

Get maximum length of msgid value.

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

Definition at line 920 of file NavigatorInterface.cpp.

◆ msgid()

uint32_t fawkes::NavigatorInterface::StopMessage::msgid ( ) const

Get msgid value.

    If zero, stops any motion. If non-zero, the component shall only
    stop the motion if the currently executed command was received
    through a message with that specific ID.

    Use the specific version whenever possible. It avoids a race
    condition if one intstructing component sends a stop, and
    another a new drive command at the same time.
Returns
msgid value

Definition at line 910 of file NavigatorInterface.cpp.

Referenced by NavGraphThread::loop().

◆ set_msgid()

void fawkes::NavigatorInterface::StopMessage::set_msgid ( const uint32_t  new_msgid)

Set msgid value.

    If zero, stops any motion. If non-zero, the component shall only
    stop the motion if the currently executed command was received
    through a message with that specific ID.

    Use the specific version whenever possible. It avoids a race
    condition if one intstructing component sends a stop, and
    another a new drive command at the same time.
Parameters
new_msgidnew msgid value

Definition at line 938 of file NavigatorInterface.cpp.

References fawkes::Interface::set_field().


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