fawkes::KatanaInterface::SetMotorEncoderMessage Class Reference

SetMotorEncoderMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::KatanaInterface::SetMotorEncoderMessage:

List of all members.

Classes
struct	SetMotorEncoderMessage_data_t
	Internal data storage, do NOT modify! More...
Public Member Functions
	SetMotorEncoderMessage (const uint32_t ini_nr, const uint32_t ini_enc)
	Constructor with initial values.
	SetMotorEncoderMessage ()
	Constructor.
	~SetMotorEncoderMessage ()
	Destructor.
	SetMotorEncoderMessage (const SetMotorEncoderMessage *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 Message *	clone () const
	Clone this message.

---

Detailed Description

SetMotorEncoderMessage Fawkes BlackBoard Interface Message.

---

Constructor & Destructor Documentation

fawkes::KatanaInterface::SetMotorEncoderMessage::SetMotorEncoderMessage	(	const uint32_t	ini_nr,
		const uint32_t	ini_enc
	)

Constructor with initial values.

Parameters:

ini_nr	initial value for nr
ini_enc	initial value for enc

Definition at line 2226 of file KatanaInterface.cpp.

References fawkes::Message::data_size, fawkes::Message::data_ptr, fawkes::Message::data_ts, fawkes::KatanaInterface::SetMotorEncoderMessage::SetMotorEncoderMessage_data_t::nr, fawkes::KatanaInterface::SetMotorEncoderMessage::SetMotorEncoderMessage_data_t::enc, fawkes::Message::add_fieldinfo(), and fawkes::IFT_UINT32.

fawkes::KatanaInterface::SetMotorEncoderMessage::SetMotorEncoderMessage

(

)

Constructor.

Definition at line 2239 of file KatanaInterface.cpp.

References fawkes::Message::data_size, fawkes::Message::data_ptr, fawkes::Message::data_ts, fawkes::Message::add_fieldinfo(), fawkes::IFT_UINT32, fawkes::KatanaInterface::SetMotorEncoderMessage::SetMotorEncoderMessage_data_t::nr, and fawkes::KatanaInterface::SetMotorEncoderMessage::SetMotorEncoderMessage_data_t::enc.

fawkes::KatanaInterface::SetMotorEncoderMessage::~SetMotorEncoderMessage

(

)

Destructor.

Definition at line 2251 of file KatanaInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::KatanaInterface::SetMotorEncoderMessage::SetMotorEncoderMessage

(

const SetMotorEncoderMessage *

m

)

Copy constructor.

Parameters:

m	message to copy from

Definition at line 2259 of file KatanaInterface.cpp.

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

---

Member Function Documentation

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

uint32_t fawkes::KatanaInterface::SetMotorEncoderMessage::enc

(

)

const

Get enc value.

Encoder value

Returns:

enc value

Definition at line 2304 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

size_t fawkes::KatanaInterface::SetMotorEncoderMessage::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 2314 of file KatanaInterface.cpp.

size_t fawkes::KatanaInterface::SetMotorEncoderMessage::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 2284 of file KatanaInterface.cpp.

uint32_t fawkes::KatanaInterface::SetMotorEncoderMessage::nr

(

)

const

Get nr value.

Motor number

Returns:

nr value

Definition at line 2274 of file KatanaInterface.cpp.

Referenced by KatanaActThread::loop().

void fawkes::KatanaInterface::SetMotorEncoderMessage::set_enc

(

const uint32_t

new_enc

)

Set enc value.

Encoder value

Parameters:

new_enc

new enc value

Definition at line 2324 of file KatanaInterface.cpp.

void fawkes::KatanaInterface::SetMotorEncoderMessage::set_nr

(

const uint32_t

new_nr

)

Set nr value.

Motor number

Parameters:

new_nr

new nr value

Definition at line 2294 of file KatanaInterface.cpp.

---

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

• src/libs/interfaces/KatanaInterface.h
• src/plugins/katana/interfaces/KatanaInterface.cpp