Fawkes API  Fawkes Development Version
fawkes::HumanoidMotionInterface::MoveHeadMessage Class Reference

MoveHeadMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::MoveHeadMessage:

Public Member Functions

 MoveHeadMessage (const float ini_yaw, const float ini_pitch, const float ini_speed)
 Constructor with initial values. More...
 
 MoveHeadMessage ()
 Constructor. More...
 
 ~MoveHeadMessage ()
 Destructor. More...
 
 MoveHeadMessage (const MoveHeadMessage *m)
 Copy constructor. More...
 
float yaw () const
 Get yaw value. More...
 
void set_yaw (const float new_yaw)
 Set yaw value. More...
 
size_t maxlenof_yaw () const
 Get maximum length of yaw value. More...
 
float pitch () const
 Get pitch value. More...
 
void set_pitch (const float new_pitch)
 Set pitch value. More...
 
size_t maxlenof_pitch () const
 Get maximum length of pitch value. More...
 
float speed () const
 Get speed value. More...
 
void set_speed (const float new_speed)
 Set speed value. More...
 
size_t maxlenof_speed () const
 Get maximum length of speed 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

Constructor & Destructor Documentation

◆ MoveHeadMessage() [1/3]

fawkes::HumanoidMotionInterface::MoveHeadMessage::MoveHeadMessage ( const float  ini_yaw,
const float  ini_pitch,
const float  ini_speed 
)

◆ MoveHeadMessage() [2/3]

◆ ~MoveHeadMessage()

fawkes::HumanoidMotionInterface::MoveHeadMessage::~MoveHeadMessage ( )

Destructor.

Definition at line 1361 of file HumanoidMotionInterface.cpp.

References fawkes::Message::data_ptr.

◆ MoveHeadMessage() [3/3]

fawkes::HumanoidMotionInterface::MoveHeadMessage::MoveHeadMessage ( const MoveHeadMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 1369 of file HumanoidMotionInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::HumanoidMotionInterface::MoveHeadMessage::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 1475 of file HumanoidMotionInterface.cpp.

◆ maxlenof_pitch()

size_t fawkes::HumanoidMotionInterface::MoveHeadMessage::maxlenof_pitch ( ) const

Get maximum length of pitch value.

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

Definition at line 1424 of file HumanoidMotionInterface.cpp.

◆ maxlenof_speed()

size_t fawkes::HumanoidMotionInterface::MoveHeadMessage::maxlenof_speed ( ) const

Get maximum length of speed value.

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

Definition at line 1454 of file HumanoidMotionInterface.cpp.

◆ maxlenof_yaw()

size_t fawkes::HumanoidMotionInterface::MoveHeadMessage::maxlenof_yaw ( ) const

Get maximum length of yaw value.

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

Definition at line 1394 of file HumanoidMotionInterface.cpp.

◆ pitch()

float fawkes::HumanoidMotionInterface::MoveHeadMessage::pitch ( ) const

Get pitch value.

Desired pitch (vertical orientation).

Returns
pitch value

Definition at line 1414 of file HumanoidMotionInterface.cpp.

Referenced by NaoQiMotionThread::loop().

◆ set_pitch()

void fawkes::HumanoidMotionInterface::MoveHeadMessage::set_pitch ( const float  new_pitch)

Set pitch value.

Desired pitch (vertical orientation).

Parameters
new_pitchnew pitch value

Definition at line 1434 of file HumanoidMotionInterface.cpp.

◆ set_speed()

void fawkes::HumanoidMotionInterface::MoveHeadMessage::set_speed ( const float  new_speed)

Set speed value.

Maximum speed in [0.0..1.0].

Parameters
new_speednew speed value

Definition at line 1464 of file HumanoidMotionInterface.cpp.

◆ set_yaw()

void fawkes::HumanoidMotionInterface::MoveHeadMessage::set_yaw ( const float  new_yaw)

Set yaw value.

Desired yaw (horizontal orientation).

Parameters
new_yawnew yaw value

Definition at line 1404 of file HumanoidMotionInterface.cpp.

◆ speed()

float fawkes::HumanoidMotionInterface::MoveHeadMessage::speed ( ) const

Get speed value.

Maximum speed in [0.0..1.0].

Returns
speed value

Definition at line 1444 of file HumanoidMotionInterface.cpp.

Referenced by NaoQiMotionThread::loop().

◆ yaw()

float fawkes::HumanoidMotionInterface::MoveHeadMessage::yaw ( ) const

Get yaw value.

Desired yaw (horizontal orientation).

Returns
yaw value

Definition at line 1384 of file HumanoidMotionInterface.cpp.

Referenced by NaoQiMotionThread::loop().


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