Fawkes API  Fawkes Development Version
fawkes::MotorInterface::AcquireControlMessage Class Reference

AcquireControlMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::MotorInterface::AcquireControlMessage:

Public Member Functions

 AcquireControlMessage (const uint32_t ini_controller, const char *ini_controller_thread_name)
 Constructor with initial values. More...
 
 AcquireControlMessage ()
 Constructor. More...
 
 ~AcquireControlMessage ()
 Destructor. More...
 
 AcquireControlMessage (const AcquireControlMessage *m)
 Copy constructor. More...
 
uint32_t controller () const
 Get controller value. More...
 
void set_controller (const uint32_t new_controller)
 Set controller value. More...
 
size_t maxlenof_controller () const
 Get maximum length of controller value. More...
 
char * controller_thread_name () const
 Get controller_thread_name value. More...
 
void set_controller_thread_name (const char *new_controller_thread_name)
 Set controller_thread_name value. More...
 
size_t maxlenof_controller_thread_name () const
 Get maximum length of controller_thread_name 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

◆ AcquireControlMessage() [1/3]

fawkes::MotorInterface::AcquireControlMessage::AcquireControlMessage ( const uint32_t  ini_controller,
const char *  ini_controller_thread_name 
)

Constructor with initial values.

Parameters
ini_controllerinitial value for controller
ini_controller_thread_nameinitial value for controller_thread_name

Definition at line 867 of file MotorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_STRING, and fawkes::IFT_UINT32.

◆ AcquireControlMessage() [2/3]

fawkes::MotorInterface::AcquireControlMessage::AcquireControlMessage ( )

◆ ~AcquireControlMessage()

fawkes::MotorInterface::AcquireControlMessage::~AcquireControlMessage ( )

Destructor.

Definition at line 892 of file MotorInterface.cpp.

References fawkes::Message::data_ptr.

◆ AcquireControlMessage() [3/3]

fawkes::MotorInterface::AcquireControlMessage::AcquireControlMessage ( const AcquireControlMessage m)

Copy constructor.

Parameters
mmessage to copy from

Definition at line 900 of file MotorInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::MotorInterface::AcquireControlMessage::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 990 of file MotorInterface.cpp.

◆ controller()

uint32_t fawkes::MotorInterface::AcquireControlMessage::controller ( ) const

Get controller value.

The ID of the controller. The controller ID is the instance serial of the sending interface. Only from this interface instance command messages are accepted.

Returns
controller value

Definition at line 918 of file MotorInterface.cpp.

◆ controller_thread_name()

char * fawkes::MotorInterface::AcquireControlMessage::controller_thread_name ( ) const

Get controller_thread_name value.

The name of the controlling thread, for easier debugging. This is informative only and actually two threads may share an interface instance (although this should be avoided since the interface locking has to be reproduced for these threads then).

Returns
controller_thread_name value

Definition at line 955 of file MotorInterface.cpp.

◆ maxlenof_controller()

size_t fawkes::MotorInterface::AcquireControlMessage::maxlenof_controller ( ) const

Get maximum length of controller value.

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

Definition at line 928 of file MotorInterface.cpp.

◆ maxlenof_controller_thread_name()

size_t fawkes::MotorInterface::AcquireControlMessage::maxlenof_controller_thread_name ( ) const

Get maximum length of controller_thread_name value.

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

Definition at line 965 of file MotorInterface.cpp.

◆ set_controller()

void fawkes::MotorInterface::AcquireControlMessage::set_controller ( const uint32_t  new_controller)

Set controller value.

The ID of the controller. The controller ID is the instance serial of the sending interface. Only from this interface instance command messages are accepted.

Parameters
new_controllernew controller value

Definition at line 941 of file MotorInterface.cpp.

◆ set_controller_thread_name()

void fawkes::MotorInterface::AcquireControlMessage::set_controller_thread_name ( const char *  new_controller_thread_name)

Set controller_thread_name value.

The name of the controlling thread, for easier debugging. This is informative only and actually two threads may share an interface instance (although this should be avoided since the interface locking has to be reproduced for these threads then).

Parameters
new_controller_thread_namenew controller_thread_name value

Definition at line 979 of file MotorInterface.cpp.


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