fawkes::PanTiltInterface::SetMarginMessage Class Reference

SetMarginMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/PanTiltInterface.h>

Inheritance diagram for fawkes::PanTiltInterface::SetMarginMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  SetMarginMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 SetMarginMessage (const float ini_pan_margin, const float ini_tilt_margin)
 Constructor with initial values.
 SetMarginMessage ()
 Constructor.
 ~SetMarginMessage ()
 Destructor.
 SetMarginMessage (const SetMarginMessage *m)
 Copy constructor.
float pan_margin () const
 Get pan_margin value.
void set_pan_margin (const float new_pan_margin)
 Set pan_margin value.
size_t maxlenof_pan_margin () const
 Get maximum length of pan_margin value.
float tilt_margin () const
 Get tilt_margin value.
void set_tilt_margin (const float new_tilt_margin)
 Set tilt_margin value.
size_t maxlenof_tilt_margin () const
 Get maximum length of tilt_margin value.
virtual Message * clone () const
 Clone this message.

Detailed Description

SetMarginMessage Fawkes BlackBoard Interface Message.

Definition at line 234 of file PanTiltInterface.h.

Constructor & Destructor Documentation

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

Constructor with initial values.

Parameters:
ini_pan_margin initial value for pan_margin
ini_tilt_margin initial value for tilt_margin

Definition at line 1350 of file PanTiltInterface.cpp.

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

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

Constructor.

Definition at line 1362 of file PanTiltInterface.cpp.

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

Referenced by clone().

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

Destructor.

Definition at line 1373 of file PanTiltInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 1381 of file PanTiltInterface.cpp.

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

Member Function Documentation

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 1460 of file PanTiltInterface.cpp.

References SetMarginMessage().

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 1406 of file PanTiltInterface.cpp.

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 1438 of file PanTiltInterface.cpp.

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 1396 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().

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_margin new pan_margin value

Definition at line 1417 of file PanTiltInterface.cpp.

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_margin new tilt_margin value

Definition at line 1449 of file PanTiltInterface.cpp.

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 1428 of file PanTiltInterface.cpp.

Referenced by PanTiltRX28Thread::loop().

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