#include <interfaces/KickerInterface.h>
Inheritance diagram for fawkes::KickerInterface:
Public Types | |
GUIDE_BALL_LEFT | |
Constant defining that the kicker shall activate the ball guidance device in such a way that the left arm is erected. | |
GUIDE_BALL_RIGHT | |
Constant defining that the kicker shall activate the ball guidance device in such a way that the right arm is erected. | |
enum | GuideBallSideEnum { GUIDE_BALL_LEFT, GUIDE_BALL_RIGHT } |
Enumeration defining on which side of the robot the ball shall be guided (and thus on which side the arm is to be erected). More... | |
Public Member Functions | |
const char * | tostring_GuideBallSideEnum (GuideBallSideEnum value) const |
Convert GuideBallSideEnum constant to string. | |
virtual bool | message_valid (const Message *message) const |
Check if message is valid and can be enqueued. | |
int32_t | num_kicks_left () const |
Get num_kicks_left value. | |
void | set_num_kicks_left (const int32_t new_num_kicks_left) |
Set num_kicks_left value. | |
size_t | maxlenof_num_kicks_left () const |
Get maximum length of num_kicks_left value. | |
int32_t | num_kicks_center () const |
Get num_kicks_center value. | |
void | set_num_kicks_center (const int32_t new_num_kicks_center) |
Set num_kicks_center value. | |
size_t | maxlenof_num_kicks_center () const |
Get maximum length of num_kicks_center value. | |
int32_t | num_kicks_right () const |
Get num_kicks_right value. | |
void | set_num_kicks_right (const int32_t new_num_kicks_right) |
Set num_kicks_right value. | |
size_t | maxlenof_num_kicks_right () const |
Get maximum length of num_kicks_right value. | |
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. | |
uint32_t | current_intensity () const |
Get current_intensity value. | |
void | set_current_intensity (const uint32_t new_current_intensity) |
Set current_intensity value. | |
size_t | maxlenof_current_intensity () const |
Get maximum length of current_intensity 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. | |
Classes | |
class | GuideBallMessage |
GuideBallMessage Fawkes BlackBoard Interface Message. More... | |
struct | KickerInterface_data_t |
Internal data storage, do NOT modify! | |
class | KickMessage |
KickMessage Fawkes BlackBoard Interface Message. More... | |
class | ResetCounterMessage |
ResetCounterMessage Fawkes BlackBoard Interface Message. More... |
In these variables it is stored how often the right, center or left kick have been triggered.
Definition at line 33 of file KickerInterface.h.
Enumeration defining on which side of the robot the ball shall be guided (and thus on which side the arm is to be erected).
Definition at line 45 of file KickerInterface.h.
void fawkes::KickerInterface::copy_values | ( | const Interface * | other | ) | [virtual] |
Copy values from other interface.
other | other interface to copy values from |
Implements fawkes::Interface.
Definition at line 277 of file KickerInterface.cpp.
References data, and fawkes::Interface::type().
Message * fawkes::KickerInterface::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 258 of file KickerInterface.cpp.
uint32_t fawkes::KickerInterface::current_intensity | ( | ) | const |
Get current_intensity value.
The currently set intensity.
Definition at line 228 of file KickerInterface.cpp.
const char * fawkes::KickerInterface::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 288 of file KickerInterface.cpp.
References tostring_GuideBallSideEnum().
KickerInterface::GuideBallSideEnum fawkes::KickerInterface::guide_ball_side | ( | ) | const |
Get guide_ball_side value.
Side where the ball guidance arm is currently erected.
Definition at line 194 of file KickerInterface.cpp.
size_t fawkes::KickerInterface::maxlenof_current_intensity | ( | ) | const |
Get maximum length of current_intensity value.
Definition at line 238 of file KickerInterface.cpp.
size_t fawkes::KickerInterface::maxlenof_guide_ball_side | ( | ) | const |
Get maximum length of guide_ball_side value.
Definition at line 204 of file KickerInterface.cpp.
size_t fawkes::KickerInterface::maxlenof_num_kicks_center | ( | ) | const |
Get maximum length of num_kicks_center value.
Definition at line 135 of file KickerInterface.cpp.
size_t fawkes::KickerInterface::maxlenof_num_kicks_left | ( | ) | const |
Get maximum length of num_kicks_left value.
Definition at line 100 of file KickerInterface.cpp.
size_t fawkes::KickerInterface::maxlenof_num_kicks_right | ( | ) | const |
Get maximum length of num_kicks_right value.
Definition at line 170 of file KickerInterface.cpp.
bool fawkes::KickerInterface::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 630 of file KickerInterface.cpp.
int32_t fawkes::KickerInterface::num_kicks_center | ( | ) | const |
Get num_kicks_center value.
Number of Center-Kicks
Definition at line 125 of file KickerInterface.cpp.
int32_t fawkes::KickerInterface::num_kicks_left | ( | ) | const |
Get num_kicks_left value.
Number of Left-Kicks
Definition at line 90 of file KickerInterface.cpp.
int32_t fawkes::KickerInterface::num_kicks_right | ( | ) | const |
Get num_kicks_right value.
Number of Right-Kicks
Definition at line 160 of file KickerInterface.cpp.
void fawkes::KickerInterface::set_current_intensity | ( | const uint32_t | new_current_intensity | ) |
Set current_intensity value.
The currently set intensity.
new_current_intensity | new current_intensity value |
Definition at line 250 of file KickerInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::KickerInterface::set_guide_ball_side | ( | const GuideBallSideEnum | new_guide_ball_side | ) |
Set guide_ball_side value.
Side where the ball guidance arm is currently erected.
new_guide_ball_side | new guide_ball_side value |
Definition at line 215 of file KickerInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::KickerInterface::set_num_kicks_center | ( | const int32_t | new_num_kicks_center | ) |
Set num_kicks_center value.
Number of Center-Kicks
new_num_kicks_center | new num_kicks_center value |
Definition at line 147 of file KickerInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::KickerInterface::set_num_kicks_left | ( | const int32_t | new_num_kicks_left | ) |
Set num_kicks_left value.
Number of Left-Kicks
new_num_kicks_left | new num_kicks_left value |
Definition at line 112 of file KickerInterface.cpp.
References fawkes::Interface::data_changed.
void fawkes::KickerInterface::set_num_kicks_right | ( | const int32_t | new_num_kicks_right | ) |
Set num_kicks_right value.
Number of Right-Kicks
new_num_kicks_right | new num_kicks_right value |
Definition at line 182 of file KickerInterface.cpp.
References fawkes::Interface::data_changed.
const char * fawkes::KickerInterface::tostring_GuideBallSideEnum | ( | GuideBallSideEnum | value | ) | const |
Convert GuideBallSideEnum constant to string.
value | value to convert to string |
Definition at line 74 of file KickerInterface.cpp.
References GUIDE_BALL_LEFT, and GUIDE_BALL_RIGHT.
Referenced by enum_tostring().