Fawkes API  Fawkes Development Version
fawkes::SoccerPenaltyInterface Class Reference

SoccerPenaltyInterface Fawkes BlackBoard Interface. More...

#include <>>

Inheritance diagram for fawkes::SoccerPenaltyInterface:

List of all members.

Classes

class  SetPenaltyMessage
 SetPenaltyMessage Fawkes BlackBoard Interface Message. More...
struct  SoccerPenaltyInterface_data_t
 Internal data storage, do NOT modify! More...

Public Member Functions

virtual bool message_valid (const Message *message) const
 Check if message is valid and can be enqueued.
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.
uint16_t remaining () const
 Get remaining value.
void set_remaining (const uint16_t new_remaining)
 Set remaining value.
size_t maxlenof_remaining () const
 Get maximum length of remaining value.
virtual Messagecreate_message (const char *type) const
 Create message based on type name.
virtual void copy_values (const Interface *other)
 Copy values from other interface.
virtual const char * enum_tostring (const char *enumtype, int val) const
 Convert arbitrary enum value to string.

Static Public Attributes

static const uint16_t SPL_PENALTY_NONE = 0
 SPL_PENALTY_NONE constant.
static const uint16_t SPL_PENALTY_BALL_HOLDING = 1
 SPL_PENALTY_BALL_HOLDING constant.
static const uint16_t SPL_PENALTY_PLAYER_PUSHING = 2
 SPL_PENALTY_PLAYER_PUSHING constant.
static const uint16_t SPL_PENALTY_OBSTRUCTION = 3
 SPL_PENALTY_OBSTRUCTION constant.
static const uint16_t SPL_PENALTY_INACTIVE_PLAYER = 4
 SPL_PENALTY_INACTIVE_PLAYER constant.
static const uint16_t SPL_PENALTY_ILLEGAL_DEFENDER = 5
 SPL_PENALTY_ILLEGAL_DEFENDER constant.
static const uint16_t SPL_PENALTY_LEAVING_THE_FIELD = 6
 SPL_PENALTY_LEAVING_THE_FIELD constant.
static const uint16_t SPL_PENALTY_PLAYING_WITH_HANDS = 7
 SPL_PENALTY_PLAYING_WITH_HANDS constant.
static const uint16_t SPL_PENALTY_REQ_FOR_PICKUP = 8
 SPL_PENALTY_REQ_FOR_PICKUP constant.
static const uint16_t SPL_PENALTY_MANUAL = 15
 SPL_PENALTY_MANUAL constant.

Detailed Description

SoccerPenaltyInterface Fawkes BlackBoard Interface.

This interface stores penalization information for soccer robots. Currently it contains constants used in the RoboCup Standard Platform League (SPL).


Member Function Documentation

void fawkes::SoccerPenaltyInterface::copy_values ( const Interface other) [virtual]

Copy values from other interface.

Parameters:
otherother interface to copy values from

Implements fawkes::Interface.

Definition at line 165 of file SoccerPenaltyInterface.cpp.

References fawkes::Message::type(), and fawkes::Interface::type().

Message * fawkes::SoccerPenaltyInterface::create_message ( const char *  type) const [virtual]

Create message based on type name.

This will create a new message of the given type. The type must be given without the InterfaceName:: prefix but just the plain class name of the message.

Parameters:
typemessage type
Returns:
message of the given type, empty
Exceptions:
UnknownTypeExceptionthrown if this interface cannot create a message of the given type.

Implements fawkes::Interface.

Definition at line 150 of file SoccerPenaltyInterface.cpp.

const char * fawkes::SoccerPenaltyInterface::enum_tostring ( const char *  enumtype,
int  val 
) const [virtual]

Convert arbitrary enum value to string.

Given the string representation of the enum type and the value this method returns the string representation of the specific value, or the string UNKNOWN if the value is not defined. An exception is thrown if the enum type is invalid.

Parameters:
enumtypeenum type as string
valvalue to convert
Returns:
string representation of value
Exceptions:
UnknownTypeExceptionthrown if enumtype is not specified for interface.

Implements fawkes::Interface.

Definition at line 176 of file SoccerPenaltyInterface.cpp.

size_t fawkes::SoccerPenaltyInterface::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 101 of file SoccerPenaltyInterface.cpp.

size_t fawkes::SoccerPenaltyInterface::maxlenof_remaining ( ) const

Get maximum length of remaining value.

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

Definition at line 132 of file SoccerPenaltyInterface.cpp.

bool fawkes::SoccerPenaltyInterface::message_valid ( const Message message) const [virtual]

Check if message is valid and can be enqueued.

Parameters:
messageMessage to check
Returns:
true if the message is valid, false otherwise.

Implements fawkes::Interface.

Definition at line 277 of file SoccerPenaltyInterface.cpp.

uint16_t fawkes::SoccerPenaltyInterface::penalty ( ) const

Get penalty value.

Current penalty code.

Returns:
penalty value

Definition at line 91 of file SoccerPenaltyInterface.cpp.

uint16_t fawkes::SoccerPenaltyInterface::remaining ( ) const

Get remaining value.

Estimated time in seconds until the robot is unpenalized.

Returns:
remaining value

Definition at line 122 of file SoccerPenaltyInterface.cpp.

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

Set penalty value.

Current penalty code.

Parameters:
new_penaltynew penalty value

Definition at line 111 of file SoccerPenaltyInterface.cpp.

References fawkes::Interface::data_changed.

Referenced by RefBoxCommThread::loop().

void fawkes::SoccerPenaltyInterface::set_remaining ( const uint16_t  new_remaining)

Set remaining value.

Estimated time in seconds until the robot is unpenalized.

Parameters:
new_remainingnew remaining value

Definition at line 142 of file SoccerPenaltyInterface.cpp.

References fawkes::Interface::data_changed.


Member Data Documentation

SPL_PENALTY_BALL_HOLDING constant.

Definition at line 41 of file SoccerPenaltyInterface.h.

SPL_PENALTY_ILLEGAL_DEFENDER constant.

Definition at line 45 of file SoccerPenaltyInterface.h.

SPL_PENALTY_INACTIVE_PLAYER constant.

Definition at line 44 of file SoccerPenaltyInterface.h.

SPL_PENALTY_LEAVING_THE_FIELD constant.

Definition at line 46 of file SoccerPenaltyInterface.h.

SPL_PENALTY_MANUAL constant.

Definition at line 49 of file SoccerPenaltyInterface.h.

SPL_PENALTY_NONE constant.

Definition at line 40 of file SoccerPenaltyInterface.h.

SPL_PENALTY_OBSTRUCTION constant.

Definition at line 43 of file SoccerPenaltyInterface.h.

SPL_PENALTY_PLAYER_PUSHING constant.

Definition at line 42 of file SoccerPenaltyInterface.h.

SPL_PENALTY_PLAYING_WITH_HANDS constant.

Definition at line 47 of file SoccerPenaltyInterface.h.

SPL_PENALTY_REQ_FOR_PICKUP constant.

Definition at line 48 of file SoccerPenaltyInterface.h.


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