Fawkes API Fawkes Development Version
fawkes::PanTiltInterface::SetMarginMessage Class Reference

SetMarginMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::PanTiltInterface::SetMarginMessage:

Public Member Functions

 SetMarginMessage (const float ini_pan_margin, const float ini_tilt_margin)
 Constructor with initial values. More...
 
 SetMarginMessage ()
 Constructor. More...
 
 ~SetMarginMessage ()
 Destructor. More...
 
 SetMarginMessage (const SetMarginMessage *m)
 Copy constructor. More...
 
float pan_margin () const
 Get pan_margin value. More...
 
void set_pan_margin (const float new_pan_margin)
 Set pan_margin value. More...
 
size_t maxlenof_pan_margin () const
 Get maximum length of pan_margin value. More...
 
float tilt_margin () const
 Get tilt_margin value. More...
 
void set_tilt_margin (const float new_tilt_margin)
 Set tilt_margin value. More...
 
size_t maxlenof_tilt_margin () const
 Get maximum length of tilt_margin 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

SetMarginMessage Fawkes BlackBoard Interface Message.

Definition at line 280 of file PanTiltInterface.h.

Constructor & Destructor Documentation

◆ SetMarginMessage() [1/3]

fawkes::PanTiltInterface::SetMarginMessage::SetMarginMessage ( const float  ini_pan_margin,
const float  ini_tilt_margin 
)

Constructor with initial values.

Parameters
ini_pan_margininitial value for pan_margin
ini_tilt_margininitial value for tilt_margin

Definition at line 1399 of file PanTiltInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.

◆ SetMarginMessage() [2/3]

fawkes::PanTiltInterface::SetMarginMessage::SetMarginMessage ( )

◆ ~SetMarginMessage()

fawkes::PanTiltInterface::SetMarginMessage::~SetMarginMessage ( )

Destructor.

Definition at line 1424 of file PanTiltInterface.cpp.

References fawkes::Interface::data_ptr.

◆ SetMarginMessage() [3/3]

fawkes::PanTiltInterface::SetMarginMessage::SetMarginMessage ( const SetMarginMessage m)
explicit

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1432 of file PanTiltInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::PanTiltInterface::SetMarginMessage::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 1512 of file PanTiltInterface.cpp.

◆ maxlenof_pan_margin()

size_t fawkes::PanTiltInterface::SetMarginMessage::maxlenof_pan_margin ( ) const

Get maximum length of pan_margin value.

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

Definition at line 1458 of file PanTiltInterface.cpp.

◆ maxlenof_tilt_margin()

size_t fawkes::PanTiltInterface::SetMarginMessage::maxlenof_tilt_margin ( ) const

Get maximum length of tilt_margin value.

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

Definition at line 1490 of file PanTiltInterface.cpp.

◆ pan_margin()

float fawkes::PanTiltInterface::SetMarginMessage::pan_margin ( ) const

Get pan_margin value.

Margin in radians around a target pan value to consider the motion as final.

Returns
pan_margin value

Definition at line 1448 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().

◆ set_pan_margin()

void fawkes::PanTiltInterface::SetMarginMessage::set_pan_margin ( const float  new_pan_margin)

Set pan_margin value.

Margin in radians around a target pan value to consider the motion as final.

Parameters
new_pan_marginnew pan_margin value

Definition at line 1469 of file PanTiltInterface.cpp.

References fawkes::Interface::set_field().

◆ set_tilt_margin()

void fawkes::PanTiltInterface::SetMarginMessage::set_tilt_margin ( const float  new_tilt_margin)

Set tilt_margin value.

Margin in radians around a target tilt value to consider the motion as final.

Parameters
new_tilt_marginnew tilt_margin value

Definition at line 1501 of file PanTiltInterface.cpp.

References fawkes::Interface::set_field().

◆ tilt_margin()

float fawkes::PanTiltInterface::SetMarginMessage::tilt_margin ( ) const

Get tilt_margin value.

Margin in radians around a target tilt value to consider the motion as final.

Returns
tilt_margin value

Definition at line 1480 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().


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