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

#include <>>

Inheritance diagram for fawkes::KickerInterface::KickMessage:

Public Member Functions

 KickMessage (const bool ini_left, const bool ini_center, const bool ini_right, const uint32_t ini_intensity)
 Constructor with initial values. More...
 
 KickMessage ()
 Constructor. More...
 
 ~KickMessage ()
 Destructor. More...
 
 KickMessage (const KickMessage *m)
 Copy constructor. More...
 
bool is_left () const
 Get left value. More...
 
void set_left (const bool new_left)
 Set left value. More...
 
size_t maxlenof_left () const
 Get maximum length of left value. More...
 
bool is_center () const
 Get center value. More...
 
void set_center (const bool new_center)
 Set center value. More...
 
size_t maxlenof_center () const
 Get maximum length of center value. More...
 
bool is_right () const
 Get right value. More...
 
void set_right (const bool new_right)
 Set right value. More...
 
size_t maxlenof_right () const
 Get maximum length of right value. More...
 
uint32_t intensity () const
 Get intensity value. More...
 
void set_intensity (const uint32_t new_intensity)
 Set intensity value. More...
 
size_t maxlenof_intensity () const
 Get maximum length of intensity 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
 
unsigned int data_size
 
message_data_ts_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

KickMessage Fawkes BlackBoard Interface Message.

Definition at line 95 of file KickerInterface.h.

Constructor & Destructor Documentation

◆ KickMessage() [1/3]

fawkes::KickerInterface::KickMessage::KickMessage ( const bool  ini_left,
const bool  ini_center,
const bool  ini_right,
const uint32_t  ini_intensity 
)

Constructor with initial values.

Parameters
ini_leftinitial value for left
ini_centerinitial value for center
ini_rightinitial value for right
ini_intensityinitial value for intensity

Definition at line 320 of file KickerInterface.cpp.

◆ KickMessage() [2/3]

fawkes::KickerInterface::KickMessage::KickMessage ( )

Constructor.

Definition at line 339 of file KickerInterface.cpp.

◆ ~KickMessage()

fawkes::KickerInterface::KickMessage::~KickMessage ( )

Destructor.

Definition at line 355 of file KickerInterface.cpp.

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

◆ KickMessage() [3/3]

fawkes::KickerInterface::KickMessage::KickMessage ( const KickMessage m)
explicit

Copy constructor.

Parameters
mmessage to copy from

Definition at line 363 of file KickerInterface.cpp.

Member Function Documentation

◆ clone()

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

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

◆ intensity()

uint32_t fawkes::KickerInterface::KickMessage::intensity ( ) const

Get intensity value.

Intensity in the range [0..255].

Returns
intensity value

Definition at line 468 of file KickerInterface.cpp.

◆ is_center()

bool fawkes::KickerInterface::KickMessage::is_center ( ) const

Get center value.

True to kick with central kicker.

Returns
center value

Definition at line 408 of file KickerInterface.cpp.

◆ is_left()

bool fawkes::KickerInterface::KickMessage::is_left ( ) const

Get left value.

True to kick with left kicker.

Returns
left value

Definition at line 378 of file KickerInterface.cpp.

◆ is_right()

bool fawkes::KickerInterface::KickMessage::is_right ( ) const

Get right value.

True to kick with right kicker.

Returns
right value

Definition at line 438 of file KickerInterface.cpp.

◆ maxlenof_center()

size_t fawkes::KickerInterface::KickMessage::maxlenof_center ( ) const

Get maximum length of center value.

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

Definition at line 418 of file KickerInterface.cpp.

◆ maxlenof_intensity()

size_t fawkes::KickerInterface::KickMessage::maxlenof_intensity ( ) const

Get maximum length of intensity value.

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

Definition at line 478 of file KickerInterface.cpp.

◆ maxlenof_left()

size_t fawkes::KickerInterface::KickMessage::maxlenof_left ( ) const

Get maximum length of left value.

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

Definition at line 388 of file KickerInterface.cpp.

◆ maxlenof_right()

size_t fawkes::KickerInterface::KickMessage::maxlenof_right ( ) const

Get maximum length of right value.

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

Definition at line 448 of file KickerInterface.cpp.

◆ set_center()

void fawkes::KickerInterface::KickMessage::set_center ( const bool  new_center)

Set center value.

True to kick with central kicker.

Parameters
new_centernew center value

Definition at line 428 of file KickerInterface.cpp.

◆ set_intensity()

void fawkes::KickerInterface::KickMessage::set_intensity ( const uint32_t  new_intensity)

Set intensity value.

Intensity in the range [0..255].

Parameters
new_intensitynew intensity value

Definition at line 488 of file KickerInterface.cpp.

◆ set_left()

void fawkes::KickerInterface::KickMessage::set_left ( const bool  new_left)

Set left value.

True to kick with left kicker.

Parameters
new_leftnew left value

Definition at line 398 of file KickerInterface.cpp.

◆ set_right()

void fawkes::KickerInterface::KickMessage::set_right ( const bool  new_right)

Set right value.

True to kick with right kicker.

Parameters
new_rightnew right value

Definition at line 458 of file KickerInterface.cpp.


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