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

SetPointOfInterestPropertyMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavGraphGeneratorInterface::SetPointOfInterestPropertyMessage:

Public Member Functions

 SetPointOfInterestPropertyMessage (const char *ini_name, const char *ini_property_name, const char *ini_property_value)
 Constructor with initial values. More...
 
 SetPointOfInterestPropertyMessage ()
 Constructor. More...
 
 ~SetPointOfInterestPropertyMessage ()
 Destructor. More...
 
 SetPointOfInterestPropertyMessage (const SetPointOfInterestPropertyMessage *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...
 
char * property_name () const
 Get property_name value. More...
 
void set_property_name (const char *new_property_name)
 Set property_name value. More...
 
size_t maxlenof_property_name () const
 Get maximum length of property_name value. More...
 
char * property_value () const
 Get property_value value. More...
 
void set_property_value (const char *new_property_value)
 Set property_value value. More...
 
size_t maxlenof_property_value () const
 Get maximum length of property_value 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

◆ SetPointOfInterestPropertyMessage() [1/3]

◆ SetPointOfInterestPropertyMessage() [2/3]

◆ ~SetPointOfInterestPropertyMessage()

fawkes::NavGraphGeneratorInterface::SetPointOfInterestPropertyMessage::~SetPointOfInterestPropertyMessage ( )

Destructor.

Definition at line 1860 of file NavGraphGeneratorInterface.cpp.

References fawkes::Message::data_ptr.

◆ SetPointOfInterestPropertyMessage() [3/3]

fawkes::NavGraphGeneratorInterface::SetPointOfInterestPropertyMessage::SetPointOfInterestPropertyMessage ( const SetPointOfInterestPropertyMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1868 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::SetPointOfInterestPropertyMessage::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 1980 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_name()

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

◆ maxlenof_property_name()

size_t fawkes::NavGraphGeneratorInterface::SetPointOfInterestPropertyMessage::maxlenof_property_name ( ) const

Get maximum length of property_name value.

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

Definition at line 1927 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_property_value()

size_t fawkes::NavGraphGeneratorInterface::SetPointOfInterestPropertyMessage::maxlenof_property_value ( ) const

Get maximum length of property_value value.

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

Definition at line 1958 of file NavGraphGeneratorInterface.cpp.

◆ name()

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

Get name value.

ID of the point of interest.

Returns
name value

Definition at line 1885 of file NavGraphGeneratorInterface.cpp.

Referenced by NavGraphGeneratorThread::loop().

◆ property_name()

char * fawkes::NavGraphGeneratorInterface::SetPointOfInterestPropertyMessage::property_name ( ) const

Get property_name value.

Name of the property to set.

Returns
property_name value

Definition at line 1917 of file NavGraphGeneratorInterface.cpp.

Referenced by NavGraphGeneratorThread::loop().

◆ property_value()

char * fawkes::NavGraphGeneratorInterface::SetPointOfInterestPropertyMessage::property_value ( ) const

Get property_value value.

Value of the property to set.

Returns
property_value value

Definition at line 1948 of file NavGraphGeneratorInterface.cpp.

Referenced by NavGraphGeneratorThread::loop().

◆ set_name()

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

Set name value.

ID of the point of interest.

Parameters
new_namenew name value

Definition at line 1907 of file NavGraphGeneratorInterface.cpp.

◆ set_property_name()

void fawkes::NavGraphGeneratorInterface::SetPointOfInterestPropertyMessage::set_property_name ( const char *  new_property_name)

Set property_name value.

Name of the property to set.

Parameters
new_property_namenew property_name value

Definition at line 1937 of file NavGraphGeneratorInterface.cpp.

◆ set_property_value()

void fawkes::NavGraphGeneratorInterface::SetPointOfInterestPropertyMessage::set_property_value ( const char *  new_property_value)

Set property_value value.

Value of the property to set.

Parameters
new_property_valuenew property_value value

Definition at line 1969 of file NavGraphGeneratorInterface.cpp.


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