Fawkes API  Fawkes Development Version
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
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!

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.
- Public Member Functions inherited from fawkes::Interface
virtual ~Interface ()
 Destructor.
bool oftype (const char *interface_type) const
 Check if interface is of given type.
const void * datachunk () const
 Get data chunk.
unsigned int datasize () const
 Get data size.
const char * type () const
 Get type of interface.
const char * id () const
 Get identifier of interface.
const char * uid () const
 Get unique identifier of interface.
unsigned short serial () const
 Get instance serial of interface.
unsigned int mem_serial () const
 Get memory serial of interface.
bool operator== (Interface &comp) const
 Check equality of two interfaces.
const unsigned char * hash () const
 Get interface hash.
size_t hash_size () const
 Get size of interface hash.
const char * hash_printable () const
 Get printable interface hash.
bool is_writer () const
 Check if this is a writing instance.
void set_validity (bool valid)
 Mark this interface invalid.
bool is_valid () const
 Check validity of interface.
void set_from_chunk (void *chunk)
 Set from a raw data chunk.
void resize_buffers (unsigned int num_buffers)
 Resize buffer array.
unsigned int num_buffers () const
 Get number of buffers.
void copy_shared_to_buffer (unsigned int buffer)
 Copy data from private memory to buffer.
void copy_private_to_buffer (unsigned int buffer)
 Copy data from private memory to buffer.
void read_from_buffer (unsigned int buffer)
 Copy data from buffer to private memory.
int compare_buffers (unsigned int buffer)
 Compare buffer to private memory.
void read ()
 Read from BlackBoard into local copy.
void write ()
 Write from local copy into BlackBoard memory.
bool has_writer () const
 Check if there is a writer for the interface.
unsigned int num_readers () const
 Get the number of readers.
bool changed () const
 Check if data has been changed.
const Timetimestamp () const
 Get timestamp of last write.
void set_auto_timestamping (bool enabled)
 Enable or disable automated timestamping.
void set_timestamp (const Time *t=NULL)
 Set timestamp.
void set_clock (Clock *clock)
 Set clock to use for timestamping.
std::list< const char * > get_message_types ()
 Obtain a list of textual representations of the message types available for this interface.
unsigned int msgq_enqueue (Message *message)
 Enqueue message at end of queue.
unsigned int msgq_enqueue_copy (Message *message)
 Enqueue copy of message at end of queue.
void msgq_remove (Message *message)
 Remove message from queue.
void msgq_remove (unsigned int message_id)
 Remove message from queue.
unsigned int msgq_size ()
 Get size of message queue.
void msgq_flush ()
 Flush all messages.
void msgq_lock ()
 Lock message queue.
bool msgq_try_lock ()
 Try to lock message queue.
void msgq_unlock ()
 Unlock message queue.
void msgq_pop ()
 Erase first message from queue.
Messagemsgq_first ()
 Get the first message from the message queue.
bool msgq_empty ()
 Check if queue is empty.
template<class MessageType >
bool msgq_first_is ()
 Check if first message has desired type.
template<class MessageType >
MessageType * msgq_first ()
 Get first message casted to the desired type.
template<class MessageType >
MessageType * msgq_first (MessageType *&msg)
 Get first message casted to the desired type.
template<class MessageType >
MessageType * msgq_first_safe (MessageType *&msg) throw ()
 Get first message casted to the desired type without exceptions.
MessageQueue::MessageIterator msgq_begin ()
 Get start iterator for message queue.
MessageQueue::MessageIterator msgq_end ()
 Get end iterator for message queue.
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance.
InterfaceFieldIterator fields_end ()
 Invalid iterator.
unsigned int num_fields ()
 Get the number of fields in the interface.

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.

Additional Inherited Members

- Static Public Member Functions inherited from fawkes::Interface
static void parse_uid (const char *uid, char **type, char **id)
 Parse UID to type and ID strings.
- Protected Member Functions inherited from fawkes::Interface
 Interface ()
 Constructor.
void set_hash (unsigned char *ihash)
 Set hash.
void add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0)
 Add an entry to the field info list.
void add_messageinfo (const char *name)
 Add an entry to the message info list.
- Protected Attributes inherited from fawkes::Interface
void * data_ptr
 Pointer to local memory storage.
unsigned int data_size
 Minimal data size to hold data storage.
bool data_changed
 Indicator if data has changed.
interface_data_ts_tdata_ts
 Pointer to data casted to timestamp struct.

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).

Definition at line 33 of file SoccerPenaltyInterface.h.


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::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.

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

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.


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