fawkes::MotorInterface::AcquireControlMessage Class Reference

AcquireControlMessage Fawkes BlackBoard Interface Message. More...

#include <interfaces/MotorInterface.h>

Inheritance diagram for fawkes::MotorInterface::AcquireControlMessage:

[legend]
List of all members.

Public Member Functions

 AcquireControlMessage (const uint32_t ini_controller, const char *ini_controller_thread_name)
 Constructor with initial values.
 AcquireControlMessage ()
 Constructor.
 ~AcquireControlMessage ()
 Destructor.
 AcquireControlMessage (const AcquireControlMessage *m)
 Copy constructor.
uint32_t controller () const
 Get controller value.
void set_controller (const uint32_t 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 Messageclone () const
 Clone this message.

Classes

struct  AcquireControlMessage_data_t
 Internal data storage, do NOT modify!

Detailed Description

AcquireControlMessage Fawkes BlackBoard Interface Message.

Definition at line 136 of file MotorInterface.h.


Constructor & Destructor Documentation

fawkes::MotorInterface::AcquireControlMessage::AcquireControlMessage ( const uint32_t  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 754 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.

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

Constructor.

Definition at line 767 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.

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

Destructor.

Definition at line 779 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 787 of file MotorInterface.cpp.

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


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

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

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_controller new controller value

Definition at line 828 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 866 of file MotorInterface.cpp.


The documentation for this class was generated from the following files:
Generated on Tue Feb 22 13:32:41 2011 for Fawkes API by  doxygen 1.4.7