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

SetFilterParamFloatMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage:

Public Member Functions

 SetFilterParamFloatMessage (const FilterType ini_filter, const char *ini_param, const float ini_value)
 Constructor with initial values. More...
 
 SetFilterParamFloatMessage ()
 Constructor. More...
 
 ~SetFilterParamFloatMessage ()
 Destructor. More...
 
 SetFilterParamFloatMessage (const SetFilterParamFloatMessage *m)
 Copy constructor. More...
 
FilterType filter () const
 Get filter value. More...
 
void set_filter (const FilterType new_filter)
 Set filter value. More...
 
size_t maxlenof_filter () const
 Get maximum length of filter value. More...
 
char * param () const
 Get param value. More...
 
void set_param (const char *new_param)
 Set param value. More...
 
size_t maxlenof_param () const
 Get maximum length of param value. More...
 
float value () const
 Get value value. More...
 
void set_value (const float new_value)
 Set value value. More...
 
size_t maxlenof_value () const
 Get maximum length of 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

◆ SetFilterParamFloatMessage() [1/3]

◆ SetFilterParamFloatMessage() [2/3]

◆ ~SetFilterParamFloatMessage()

fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::~SetFilterParamFloatMessage ( )

Destructor.

Definition at line 778 of file NavGraphGeneratorInterface.cpp.

References fawkes::Message::data_ptr.

◆ SetFilterParamFloatMessage() [3/3]

fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::SetFilterParamFloatMessage ( const SetFilterParamFloatMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 786 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::SetFilterParamFloatMessage::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 898 of file NavGraphGeneratorInterface.cpp.

◆ filter()

NavGraphGeneratorInterface::FilterType fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::filter ( ) const

Get filter value.

Which filter to enable/disable.

Returns
filter value

Definition at line 802 of file NavGraphGeneratorInterface.cpp.

Referenced by NavGraphGeneratorThread::loop().

◆ maxlenof_filter()

size_t fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::maxlenof_filter ( ) const

Get maximum length of filter value.

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

Definition at line 812 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_param()

size_t fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::maxlenof_param ( ) const

Get maximum length of param value.

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

Definition at line 844 of file NavGraphGeneratorInterface.cpp.

◆ maxlenof_value()

size_t fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::maxlenof_value ( ) const

Get maximum length of value value.

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

Definition at line 876 of file NavGraphGeneratorInterface.cpp.

◆ param()

char * fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::param ( ) const

Get param value.

Parameter name, see FilterType description for possible values.

Returns
param value

Definition at line 834 of file NavGraphGeneratorInterface.cpp.

Referenced by NavGraphGeneratorThread::loop().

◆ set_filter()

void fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::set_filter ( const FilterType  new_filter)

Set filter value.

Which filter to enable/disable.

Parameters
new_filternew filter value

Definition at line 823 of file NavGraphGeneratorInterface.cpp.

◆ set_param()

void fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::set_param ( const char *  new_param)

Set param value.

Parameter name, see FilterType description for possible values.

Parameters
new_paramnew param value

Definition at line 855 of file NavGraphGeneratorInterface.cpp.

◆ set_value()

void fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::set_value ( const float  new_value)

Set value value.

True to enable, false to disable

Parameters
new_valuenew value value

Definition at line 887 of file NavGraphGeneratorInterface.cpp.

◆ value()

float fawkes::NavGraphGeneratorInterface::SetFilterParamFloatMessage::value ( ) const

Get value value.

True to enable, false to disable

Returns
value value

Definition at line 866 of file NavGraphGeneratorInterface.cpp.

Referenced by NavGraphGeneratorThread::loop().


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