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

WalkArcMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::HumanoidMotionInterface::WalkArcMessage:

Public Member Functions

 WalkArcMessage (const float ini_angle, const float ini_radius)
 Constructor with initial values. More...
 
 WalkArcMessage ()
 Constructor. More...
 
 ~WalkArcMessage ()
 Destructor. More...
 
 WalkArcMessage (const WalkArcMessage *m)
 Copy constructor. More...
 
float angle () const
 Get angle value. More...
 
void set_angle (const float new_angle)
 Set angle value. More...
 
size_t maxlenof_angle () const
 Get maximum length of angle value. More...
 
float radius () const
 Get radius value. More...
 
void set_radius (const float new_radius)
 Set radius value. More...
 
size_t maxlenof_radius () const
 Get maximum length of radius 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

◆ WalkArcMessage() [1/3]

fawkes::HumanoidMotionInterface::WalkArcMessage::WalkArcMessage ( const float  ini_angle,
const float  ini_radius 
)

◆ WalkArcMessage() [2/3]

◆ ~WalkArcMessage()

fawkes::HumanoidMotionInterface::WalkArcMessage::~WalkArcMessage ( )

Destructor.

Definition at line 569 of file HumanoidMotionInterface.cpp.

References fawkes::Message::data_ptr.

◆ WalkArcMessage() [3/3]

fawkes::HumanoidMotionInterface::WalkArcMessage::WalkArcMessage ( const WalkArcMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 577 of file HumanoidMotionInterface.cpp.

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

Member Function Documentation

◆ angle()

float fawkes::HumanoidMotionInterface::WalkArcMessage::angle ( ) const

Get angle value.

Angle in radians to turn over the way.

Returns
angle value

Definition at line 592 of file HumanoidMotionInterface.cpp.

◆ clone()

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

◆ maxlenof_angle()

size_t fawkes::HumanoidMotionInterface::WalkArcMessage::maxlenof_angle ( ) const

Get maximum length of angle value.

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

Definition at line 602 of file HumanoidMotionInterface.cpp.

◆ maxlenof_radius()

size_t fawkes::HumanoidMotionInterface::WalkArcMessage::maxlenof_radius ( ) const

Get maximum length of radius value.

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

Definition at line 632 of file HumanoidMotionInterface.cpp.

◆ radius()

float fawkes::HumanoidMotionInterface::WalkArcMessage::radius ( ) const

Get radius value.

Radius in m of the circle in m.

Returns
radius value

Definition at line 622 of file HumanoidMotionInterface.cpp.

◆ set_angle()

void fawkes::HumanoidMotionInterface::WalkArcMessage::set_angle ( const float  new_angle)

Set angle value.

Angle in radians to turn over the way.

Parameters
new_anglenew angle value

Definition at line 612 of file HumanoidMotionInterface.cpp.

◆ set_radius()

void fawkes::HumanoidMotionInterface::WalkArcMessage::set_radius ( const float  new_radius)

Set radius value.

Radius in m of the circle in m.

Parameters
new_radiusnew radius value

Definition at line 642 of file HumanoidMotionInterface.cpp.


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