SoccerPenaltyInterface Fawkes BlackBoard Interface. More...
#include <interfaces/SoccerPenaltyInterface.h>
Classes | |
class | SetPenaltyMessage |
SetPenaltyMessage Fawkes BlackBoard Interface Message. More... | |
struct | SoccerPenaltyInterface_data_t |
Internal data storage, do NOT modify! | |
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 Message * | create_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. |
SoccerPenaltyInterface Fawkes BlackBoard Interface.
This interface stores penalization information for soccer robots. Currently it contains constants used in the RoboCup Standard Platform League (SPL).
Definition at line 33 of file SoccerPenaltyInterface.h.
void fawkes::SoccerPenaltyInterface::copy_values | ( | const Interface * | other | ) | [virtual] |
Copy values from other interface.
other | other interface to copy values from |
Definition at line 165 of file SoccerPenaltyInterface.cpp.
References 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.
type | message type |
UnknownTypeException | thrown 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.
enumtype | enum type as string | |
val | value to convert |
UnknownTypeException | thrown 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.
Definition at line 101 of file SoccerPenaltyInterface.cpp.
size_t fawkes::SoccerPenaltyInterface::maxlenof_remaining | ( | ) | const |
Get maximum length of remaining value.
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.
message | Message to check |
Implements fawkes::Interface.
Definition at line 277 of file SoccerPenaltyInterface.cpp.
uint16_t fawkes::SoccerPenaltyInterface::penalty | ( | ) | const |
Get penalty value.
Current penalty code.
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.
Definition at line 122 of file SoccerPenaltyInterface.cpp.
void fawkes::SoccerPenaltyInterface::set_penalty | ( | const uint16_t | new_penalty | ) |
Set penalty value.
Current penalty code.
new_penalty | new penalty value |
Definition at line 111 of file SoccerPenaltyInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::SoccerPenaltyInterface::set_remaining | ( | const uint16_t | new_remaining | ) |
Set remaining value.
Estimated time in seconds until the robot is unpenalized.
new_remaining | new remaining value |
Definition at line 142 of file SoccerPenaltyInterface.cpp.
References fawkes::Interface::data_changed.
const uint16_t fawkes::SoccerPenaltyInterface::SPL_PENALTY_BALL_HOLDING = 1 [static] |
SPL_PENALTY_BALL_HOLDING constant.
Definition at line 41 of file SoccerPenaltyInterface.h.
const uint16_t fawkes::SoccerPenaltyInterface::SPL_PENALTY_ILLEGAL_DEFENDER = 5 [static] |
SPL_PENALTY_ILLEGAL_DEFENDER constant.
Definition at line 45 of file SoccerPenaltyInterface.h.
const uint16_t fawkes::SoccerPenaltyInterface::SPL_PENALTY_INACTIVE_PLAYER = 4 [static] |
SPL_PENALTY_INACTIVE_PLAYER constant.
Definition at line 44 of file SoccerPenaltyInterface.h.
const uint16_t fawkes::SoccerPenaltyInterface::SPL_PENALTY_LEAVING_THE_FIELD = 6 [static] |
SPL_PENALTY_LEAVING_THE_FIELD constant.
Definition at line 46 of file SoccerPenaltyInterface.h.
const uint16_t fawkes::SoccerPenaltyInterface::SPL_PENALTY_MANUAL = 15 [static] |
SPL_PENALTY_MANUAL constant.
Definition at line 49 of file SoccerPenaltyInterface.h.
const uint16_t fawkes::SoccerPenaltyInterface::SPL_PENALTY_NONE = 0 [static] |
SPL_PENALTY_NONE constant.
Definition at line 40 of file SoccerPenaltyInterface.h.
const uint16_t fawkes::SoccerPenaltyInterface::SPL_PENALTY_OBSTRUCTION = 3 [static] |
SPL_PENALTY_OBSTRUCTION constant.
Definition at line 43 of file SoccerPenaltyInterface.h.
const uint16_t fawkes::SoccerPenaltyInterface::SPL_PENALTY_PLAYER_PUSHING = 2 [static] |
SPL_PENALTY_PLAYER_PUSHING constant.
Definition at line 42 of file SoccerPenaltyInterface.h.
const uint16_t fawkes::SoccerPenaltyInterface::SPL_PENALTY_PLAYING_WITH_HANDS = 7 [static] |
SPL_PENALTY_PLAYING_WITH_HANDS constant.
Definition at line 47 of file SoccerPenaltyInterface.h.
const uint16_t fawkes::SoccerPenaltyInterface::SPL_PENALTY_REQ_FOR_PICKUP = 8 [static] |
SPL_PENALTY_REQ_FOR_PICKUP constant.
Definition at line 48 of file SoccerPenaltyInterface.h.