fawkes::GameStateInterface::SetKickoffMessage Class Reference

SetKickoffMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/GameStateInterface.h>

Inheritance diagram for fawkes::GameStateInterface::SetKickoffMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  SetKickoffMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 SetKickoffMessage (const bool ini_kickoff)
 Constructor with initial values.
 SetKickoffMessage ()
 Constructor.
 ~SetKickoffMessage ()
 Destructor.
 SetKickoffMessage (const SetKickoffMessage *m)
 Copy constructor.
bool is_kickoff () const
 Get kickoff value.
void set_kickoff (const bool new_kickoff)
 Set kickoff value.
size_t maxlenof_kickoff () const
 Get maximum length of kickoff value.
virtual Message * clone () const
 Clone this message.

Detailed Description

SetKickoffMessage Fawkes BlackBoard Interface Message.

Definition at line 138 of file GameStateInterface.h.

Constructor & Destructor Documentation

fawkes::GameStateInterface::SetKickoffMessage::SetKickoffMessage ( const bool  ini_kickoff  ) 

Constructor with initial values.

Parameters:
ini_kickoff initial value for kickoff

Definition at line 496 of file GameStateInterface.cpp.

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

fawkes::GameStateInterface::SetKickoffMessage::SetKickoffMessage (  ) 

Constructor.

Definition at line 506 of file GameStateInterface.cpp.

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

Referenced by clone().

fawkes::GameStateInterface::SetKickoffMessage::~SetKickoffMessage (  ) 

Destructor.

Definition at line 516 of file GameStateInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::GameStateInterface::SetKickoffMessage::SetKickoffMessage ( const SetKickoffMessage *  m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 524 of file GameStateInterface.cpp.

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

Member Function Documentation

Message * fawkes::GameStateInterface::SetKickoffMessage::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 569 of file GameStateInterface.cpp.

References SetKickoffMessage().

bool fawkes::GameStateInterface::SetKickoffMessage::is_kickoff (  )  const

Get kickoff value.

Whether we have kickoff

Returns:
kickoff value

Definition at line 538 of file GameStateInterface.cpp.

Referenced by RefBoxCommThread::loop().

size_t fawkes::GameStateInterface::SetKickoffMessage::maxlenof_kickoff (  )  const

Get maximum length of kickoff value.

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

Definition at line 548 of file GameStateInterface.cpp.

void fawkes::GameStateInterface::SetKickoffMessage::set_kickoff ( const bool  new_kickoff  ) 

Set kickoff value.

Whether we have kickoff

Parameters:
new_kickoff new kickoff value

Definition at line 558 of file GameStateInterface.cpp.

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