Fawkes API  Fawkes Development Version
fawkes::KickerInterface::GuideBallMessage Class Reference

GuideBallMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::KickerInterface::GuideBallMessage:

Public Member Functions

 GuideBallMessage (const GuideBallSideEnum ini_guide_ball_side)
 Constructor with initial values. More...
 
 GuideBallMessage ()
 Constructor. More...
 
 ~GuideBallMessage ()
 Destructor. More...
 
 GuideBallMessage (const GuideBallMessage *m)
 Copy constructor. More...
 
GuideBallSideEnum guide_ball_side () const
 Get guide_ball_side value. More...
 
void set_guide_ball_side (const GuideBallSideEnum new_guide_ball_side)
 Set guide_ball_side value. More...
 
size_t maxlenof_guide_ball_side () const
 Get maximum length of guide_ball_side value. More...
 
virtual Messageclone () const
 Clone this message. More...
 
- Public Member Functions inherited from fawkes::Message
 Message (const char *type)
 Constructor. More...
 
 Message (const Message *mesg)
 Copy constructor. More...
 
 Message (const Message &mesg)
 Copy constructor. More...
 
virtual ~Message ()
 Destructor. More...
 
Messageoperator= (const Message &m)
 Assign this message to given message. More...
 
unsigned int id () const
 Get message ID. More...
 
void set_id (unsigned int message_id)
 Set message ID. More...
 
void mark_enqueued ()
 Mark message as being enqueued. More...
 
bool enqueued () const
 Check is message has been enqueued. More...
 
const Timetime_enqueued () const
 Get time when message was enqueued. More...
 
unsigned int sender_id () const
 Get ID of sender. More...
 
const char * sender_thread_name () const
 Get sender of message. More...
 
Interfaceinterface () const
 Get transmitting interface. More...
 
const char * type () const
 Get message type. More...
 
InterfaceFieldIterator fields ()
 Get iterator over all fields of this interface instance. More...
 
InterfaceFieldIterator fields_end ()
 Invalid iterator. More...
 
unsigned int num_fields () const
 Get the number of fields in the message. More...
 
const void * datachunk () const
 Get pointer to data. More...
 
unsigned int datasize () const
 Get size of data. More...
 
unsigned int hops () const
 Get number of hops. More...
 
void set_hops (unsigned int hops)
 Set number of hops. More...
 
void set_from_chunk (const void *chunk)
 Set from raw data chunk. More...
 
unsigned int recipient () const
 Get recipient memory serial. More...
 
template<class MessageType >
bool is_of_type ()
 Check if message has desired type. More...
 
template<class MessageType >
MessageType * as_type ()
 Cast message to given type if possible. More...
 
- Public Member Functions inherited from fawkes::RefCount
 RefCount ()
 Constructor. More...
 
virtual ~RefCount ()
 Destructor. More...
 
void ref ()
 Increment reference count. More...
 
void unref ()
 Decrement reference count and conditionally delete this instance. More...
 
unsigned int refcount ()
 Get reference count for this instance. More...
 

Additional Inherited Members

- Protected Member Functions inherited from fawkes::Message
void add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0, const interface_enum_map_t *enum_map=0)
 Add an entry to the info list. More...
 
- Protected Attributes inherited from fawkes::Message
void * data_ptr
 Pointer to memory that contains local data. More...
 
unsigned int data_size
 Size of memory needed to hold all data. More...
 
message_data_ts_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

GuideBallMessage Fawkes BlackBoard Interface Message.

Definition at line 142 of file KickerInterface.h.

Constructor & Destructor Documentation

◆ GuideBallMessage() [1/3]

fawkes::KickerInterface::GuideBallMessage::GuideBallMessage ( const GuideBallSideEnum  ini_guide_ball_side)

Constructor with initial values.

Parameters
ini_guide_ball_sideinitial value for guide_ball_side

Definition at line 555 of file KickerInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::KickerInterface::GUIDE_BALL_LEFT, fawkes::KickerInterface::GUIDE_BALL_RIGHT, and fawkes::IFT_ENUM.

◆ GuideBallMessage() [2/3]

◆ ~GuideBallMessage()

fawkes::KickerInterface::GuideBallMessage::~GuideBallMessage ( )

Destructor.

Definition at line 581 of file KickerInterface.cpp.

References fawkes::Message::data_ptr.

◆ GuideBallMessage() [3/3]

fawkes::KickerInterface::GuideBallMessage::GuideBallMessage ( const GuideBallMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 589 of file KickerInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::KickerInterface::GuideBallMessage::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 635 of file KickerInterface.cpp.

◆ guide_ball_side()

KickerInterface::GuideBallSideEnum fawkes::KickerInterface::GuideBallMessage::guide_ball_side ( ) const

Get guide_ball_side value.

Side where to guide the ball and erect the arm.

Returns
guide_ball_side value

Definition at line 604 of file KickerInterface.cpp.

◆ maxlenof_guide_ball_side()

size_t fawkes::KickerInterface::GuideBallMessage::maxlenof_guide_ball_side ( ) const

Get maximum length of guide_ball_side value.

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

Definition at line 614 of file KickerInterface.cpp.

◆ set_guide_ball_side()

void fawkes::KickerInterface::GuideBallMessage::set_guide_ball_side ( const GuideBallSideEnum  new_guide_ball_side)

Set guide_ball_side value.

Side where to guide the ball and erect the arm.

Parameters
new_guide_ball_sidenew guide_ball_side value

Definition at line 624 of file KickerInterface.cpp.


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