fawkes::MotorInterface::AcquireControlMessage Class Reference

AcquireControlMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/MotorInterface.h>

Inheritance diagram for fawkes::MotorInterface::AcquireControlMessage:

Inheritance graph
[legend]

List of all members.


Classes

struct  AcquireControlMessage_data_t
 Internal data storage, do NOT modify!

Public Member Functions

 AcquireControlMessage (const unsigned int ini_controller, const char *ini_controller_thread_name)
 Constructor with initial values.
 AcquireControlMessage ()
 Constructor.
 ~AcquireControlMessage ()
 Destructor.
 AcquireControlMessage (const AcquireControlMessage *m)
 Copy constructor.
unsigned int controller () const
 Get controller value.
void set_controller (const unsigned int new_controller)
 Set controller value.
size_t maxlenof_controller () const
 Get maximum length of controller value.
char * controller_thread_name () const
 Get controller_thread_name value.
void set_controller_thread_name (const char *new_controller_thread_name)
 Set controller_thread_name value.
size_t maxlenof_controller_thread_name () const
 Get maximum length of controller_thread_name value.
virtual Message * clone () const
 Clone this message.

Detailed Description

AcquireControlMessage Fawkes BlackBoard Interface Message.

Definition at line 128 of file MotorInterface.h.

Constructor & Destructor Documentation

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

Constructor with initial values.

Parameters:
ini_controller initial value for controller
ini_controller_thread_name initial value for controller_thread_name

Definition at line 730 of file MotorInterface.cpp.

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

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

Constructor.

Definition at line 742 of file MotorInterface.cpp.

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

Referenced by clone().

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

Destructor.

Definition at line 753 of file MotorInterface.cpp.

References fawkes::Message::data_ptr.

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

Copy constructor.

Parameters:
m message to copy from

Definition at line 761 of file MotorInterface.cpp.

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

Member Function Documentation

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 850 of file MotorInterface.cpp.

References AcquireControlMessage().

unsigned int 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 778 of file MotorInterface.cpp.

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 815 of file MotorInterface.cpp.

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 788 of file MotorInterface.cpp.

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 825 of file MotorInterface.cpp.

void fawkes::MotorInterface::AcquireControlMessage::set_controller ( const unsigned int  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_controller new controller value

Definition at line 801 of file MotorInterface.cpp.

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_name new controller_thread_name value

Definition at line 839 of file MotorInterface.cpp.

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