Fawkes API  Fawkes Development Version
fawkes::KatanaInterface::MoveMotorEncoderMessage Class Reference

MoveMotorEncoderMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::KatanaInterface::MoveMotorEncoderMessage:

List of all members.

Classes

struct  MoveMotorEncoderMessage_data_t
 Internal data storage, do NOT modify! More...

Public Member Functions

 MoveMotorEncoderMessage (const uint32_t ini_nr, const uint32_t ini_enc)
 Constructor with initial values.
 MoveMotorEncoderMessage ()
 Constructor.
 ~MoveMotorEncoderMessage ()
 Destructor.
 MoveMotorEncoderMessage (const MoveMotorEncoderMessage *m)
 Copy constructor.
uint32_t nr () const
 Get nr value.
void set_nr (const uint32_t new_nr)
 Set nr value.
size_t maxlenof_nr () const
 Get maximum length of nr value.
uint32_t enc () const
 Get enc value.
void set_enc (const uint32_t new_enc)
 Set enc value.
size_t maxlenof_enc () const
 Get maximum length of enc value.
virtual Messageclone () const
 Clone this message.

Detailed Description


Constructor & Destructor Documentation

fawkes::KatanaInterface::MoveMotorEncoderMessage::MoveMotorEncoderMessage ( const uint32_t  ini_nr,
const uint32_t  ini_enc 
)
fawkes::KatanaInterface::MoveMotorEncoderMessage::~MoveMotorEncoderMessage ( )

Destructor.

Definition at line 2375 of file KatanaInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::KatanaInterface::MoveMotorEncoderMessage::MoveMotorEncoderMessage ( const MoveMotorEncoderMessage m)

Copy constructor.

Parameters:
mmessage to copy from

Definition at line 2383 of file KatanaInterface.cpp.

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


Member Function Documentation

Message * fawkes::KatanaInterface::MoveMotorEncoderMessage::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 2459 of file KatanaInterface.cpp.

uint32_t fawkes::KatanaInterface::MoveMotorEncoderMessage::enc ( ) const

Get enc value.

Encoder value

Returns:
enc value

Definition at line 2428 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

size_t fawkes::KatanaInterface::MoveMotorEncoderMessage::maxlenof_enc ( ) const

Get maximum length of enc value.

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

Definition at line 2438 of file KatanaInterface.cpp.

size_t fawkes::KatanaInterface::MoveMotorEncoderMessage::maxlenof_nr ( ) const

Get maximum length of nr value.

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

Definition at line 2408 of file KatanaInterface.cpp.

uint32_t fawkes::KatanaInterface::MoveMotorEncoderMessage::nr ( ) const

Get nr value.

Motor number

Returns:
nr value

Definition at line 2398 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

void fawkes::KatanaInterface::MoveMotorEncoderMessage::set_enc ( const uint32_t  new_enc)

Set enc value.

Encoder value

Parameters:
new_encnew enc value

Definition at line 2448 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::MoveMotorEncoderMessage::set_nr ( const uint32_t  new_nr)

Set nr value.

Motor number

Parameters:
new_nrnew nr value

Definition at line 2418 of file KatanaInterface.cpp.


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