Classes | Public Member Functions

fawkes::SoccerPenaltyInterface::SetPenaltyMessage Class Reference

SetPenaltyMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::SoccerPenaltyInterface::SetPenaltyMessage:
Inheritance graph
[legend]

List of all members.

Classes

struct  SetPenaltyMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 SetPenaltyMessage (const uint16_t ini_penalty)
 Constructor with initial values.
 SetPenaltyMessage ()
 Constructor.
 ~SetPenaltyMessage ()
 Destructor.
 SetPenaltyMessage (const SetPenaltyMessage *m)
 Copy constructor.
uint16_t penalty () const
 Get penalty value.
void set_penalty (const uint16_t new_penalty)
 Set penalty value.
size_t maxlenof_penalty () const
 Get maximum length of penalty value.
virtual Messageclone () const
 Clone this message.

Detailed Description

SetPenaltyMessage Fawkes BlackBoard Interface Message.

Definition at line 66 of file SoccerPenaltyInterface.h.


Constructor & Destructor Documentation

fawkes::SoccerPenaltyInterface::SetPenaltyMessage::SetPenaltyMessage ( const uint16_t  ini_penalty  ) 

Constructor with initial values.

Parameters:
ini_penalty initial value for penalty

Definition at line 192 of file SoccerPenaltyInterface.cpp.

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

fawkes::SoccerPenaltyInterface::SetPenaltyMessage::SetPenaltyMessage (  ) 
fawkes::SoccerPenaltyInterface::SetPenaltyMessage::~SetPenaltyMessage (  ) 

Destructor.

Definition at line 214 of file SoccerPenaltyInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::SoccerPenaltyInterface::SetPenaltyMessage::SetPenaltyMessage ( const SetPenaltyMessage m  ) 

Copy constructor.

Parameters:
m message to copy from

Definition at line 222 of file SoccerPenaltyInterface.cpp.

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


Member Function Documentation

Message * fawkes::SoccerPenaltyInterface::SetPenaltyMessage::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 268 of file SoccerPenaltyInterface.cpp.

References SetPenaltyMessage().

size_t fawkes::SoccerPenaltyInterface::SetPenaltyMessage::maxlenof_penalty (  )  const

Get maximum length of penalty value.

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

Definition at line 247 of file SoccerPenaltyInterface.cpp.

uint16_t fawkes::SoccerPenaltyInterface::SetPenaltyMessage::penalty (  )  const

Get penalty value.

Current penalty code.

Returns:
penalty value

Definition at line 237 of file SoccerPenaltyInterface.cpp.

void fawkes::SoccerPenaltyInterface::SetPenaltyMessage::set_penalty ( const uint16_t  new_penalty  ) 

Set penalty value.

Current penalty code.

Parameters:
new_penalty new penalty value

Definition at line 257 of file SoccerPenaltyInterface.cpp.


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