Fawkes API Fawkes Development Version
fawkes::DynamicReconfigureInterface::SetFloatMessage Class Reference

SetFloatMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::DynamicReconfigureInterface::SetFloatMessage:

Public Member Functions

 SetFloatMessage (const char *ini_service, const char *ini_parameter, const float ini_value)
 Constructor with initial values. More...
 
 SetFloatMessage ()
 Constructor. More...
 
 ~SetFloatMessage ()
 Destructor. More...
 
 SetFloatMessage (const SetFloatMessage *m)
 Copy constructor. More...
 
char * service () const
 Get service value. More...
 
void set_service (const char *new_service)
 Set service value. More...
 
size_t maxlenof_service () const
 Get maximum length of service value. More...
 
char * parameter () const
 Get parameter value. More...
 
void set_parameter (const char *new_parameter)
 Set parameter value. More...
 
size_t maxlenof_parameter () const
 Get maximum length of parameter 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...
 
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

◆ SetFloatMessage() [1/3]

fawkes::DynamicReconfigureInterface::SetFloatMessage::SetFloatMessage ( const char *  ini_service,
const char *  ini_parameter,
const float  ini_value 
)

Constructor with initial values.

Parameters
ini_serviceinitial value for service
ini_parameterinitial value for parameter
ini_valueinitial value for value

Definition at line 1076 of file DynamicReconfigureInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::DynamicReconfigureInterface::Failed, fawkes::IFT_FLOAT, fawkes::IFT_STRING, and fawkes::DynamicReconfigureInterface::Succeeded.

◆ SetFloatMessage() [2/3]

◆ ~SetFloatMessage()

fawkes::DynamicReconfigureInterface::SetFloatMessage::~SetFloatMessage ( )

Destructor.

Definition at line 1110 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::data_ptr.

◆ SetFloatMessage() [3/3]

fawkes::DynamicReconfigureInterface::SetFloatMessage::SetFloatMessage ( const SetFloatMessage m)
explicit

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1118 of file DynamicReconfigureInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::DynamicReconfigureInterface::SetFloatMessage::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 1224 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_parameter()

size_t fawkes::DynamicReconfigureInterface::SetFloatMessage::maxlenof_parameter ( ) const

Get maximum length of parameter value.

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

Definition at line 1173 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_service()

size_t fawkes::DynamicReconfigureInterface::SetFloatMessage::maxlenof_service ( ) const

Get maximum length of service value.

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

Definition at line 1143 of file DynamicReconfigureInterface.cpp.

◆ maxlenof_value()

size_t fawkes::DynamicReconfigureInterface::SetFloatMessage::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 1203 of file DynamicReconfigureInterface.cpp.

◆ parameter()

char * fawkes::DynamicReconfigureInterface::SetFloatMessage::parameter ( ) const

Get parameter value.

Name of the ROS parameter.

Returns
parameter value

Definition at line 1163 of file DynamicReconfigureInterface.cpp.

◆ service()

char * fawkes::DynamicReconfigureInterface::SetFloatMessage::service ( ) const

Get service value.

Name of the ROS service for dynamic reconfiguration.

Returns
service value

Definition at line 1133 of file DynamicReconfigureInterface.cpp.

◆ set_parameter()

void fawkes::DynamicReconfigureInterface::SetFloatMessage::set_parameter ( const char *  new_parameter)

Set parameter value.

Name of the ROS parameter.

Parameters
new_parameternew parameter value

Definition at line 1183 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::set_field().

◆ set_service()

void fawkes::DynamicReconfigureInterface::SetFloatMessage::set_service ( const char *  new_service)

Set service value.

Name of the ROS service for dynamic reconfiguration.

Parameters
new_servicenew service value

Definition at line 1153 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::set_field().

◆ set_value()

void fawkes::DynamicReconfigureInterface::SetFloatMessage::set_value ( const float  new_value)

Set value value.

The value to set.

Parameters
new_valuenew value value

Definition at line 1213 of file DynamicReconfigureInterface.cpp.

References fawkes::Interface::set_field().

◆ value()

float fawkes::DynamicReconfigureInterface::SetFloatMessage::value ( ) const

Get value value.

The value to set.

Returns
value value

Definition at line 1193 of file DynamicReconfigureInterface.cpp.


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