fawkes::KickerInterface::GuideBallMessage Class Reference

GuideBallMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/KickerInterface.h>

Inheritance diagram for fawkes::KickerInterface::GuideBallMessage:

[legend]
List of all members.

Public Member Functions

 GuideBallMessage (const GuideBallSideEnum ini_guide_ball_side)
 Constructor with initial values.
 GuideBallMessage ()
 Constructor.
 ~GuideBallMessage ()
 Destructor.
 GuideBallMessage (const GuideBallMessage *m)
 Copy constructor.
GuideBallSideEnum guide_ball_side () const
 Get guide_ball_side value.
void set_guide_ball_side (const GuideBallSideEnum new_guide_ball_side)
 Set guide_ball_side value.
size_t maxlenof_guide_ball_side () const
 Get maximum length of guide_ball_side value.
virtual Messageclone () const
 Clone this message.

Classes

struct  GuideBallMessage_data_t
 Internal data storage, do NOT modify!

Detailed Description

GuideBallMessage Fawkes BlackBoard Interface Message.

Definition at line 145 of file KickerInterface.h.


Constructor & Destructor Documentation

fawkes::KickerInterface::GuideBallMessage::GuideBallMessage ( const GuideBallSideEnum  ini_guide_ball_side  ) 

Constructor with initial values.

Parameters:
ini_guide_ball_side initial value for guide_ball_side

Definition at line 545 of file KickerInterface.cpp.

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

fawkes::KickerInterface::GuideBallMessage::GuideBallMessage (  ) 

Constructor.

Definition at line 556 of file KickerInterface.cpp.

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

fawkes::KickerInterface::GuideBallMessage::~GuideBallMessage (  ) 

Destructor.

Definition at line 567 of file KickerInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::KickerInterface::GuideBallMessage::GuideBallMessage ( const GuideBallMessage m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 575 of file KickerInterface.cpp.

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


Member Function Documentation

Message * fawkes::KickerInterface::GuideBallMessage::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 621 of file KickerInterface.cpp.

KickerInterface::GuideBallSideEnum fawkes::KickerInterface::GuideBallMessage::guide_ball_side (  )  const

Get guide_ball_side value.

Side where to guide the ball and erect the arm.

Returns:
guide_ball_side value

Definition at line 590 of file KickerInterface.cpp.

size_t fawkes::KickerInterface::GuideBallMessage::maxlenof_guide_ball_side (  )  const

Get maximum length of guide_ball_side value.

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

Definition at line 600 of file KickerInterface.cpp.

void fawkes::KickerInterface::GuideBallMessage::set_guide_ball_side ( const GuideBallSideEnum  new_guide_ball_side  ) 

Set guide_ball_side value.

Side where to guide the ball and erect the arm.

Parameters:
new_guide_ball_side new guide_ball_side value

Definition at line 610 of file KickerInterface.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:32:41 2011 for Fawkes API by  doxygen 1.4.7