fawkes::NaoSensorInterface::StartUltrasonicMessage Class Reference

StartUltrasonicMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NaoSensorInterface::StartUltrasonicMessage:

List of all members.

Classes
struct	StartUltrasonicMessage_data_t
	Internal data storage, do NOT modify! More...
Public Member Functions
	StartUltrasonicMessage (const UltrasonicDirection ini_ultrasonic_direction)
	Constructor with initial values.
	StartUltrasonicMessage ()
	Constructor.
	~StartUltrasonicMessage ()
	Destructor.
	StartUltrasonicMessage (const StartUltrasonicMessage *m)
	Copy constructor.
UltrasonicDirection	ultrasonic_direction () const
	Get ultrasonic_direction value.
void	set_ultrasonic_direction (const UltrasonicDirection new_ultrasonic_direction)
	Set ultrasonic_direction value.
size_t	maxlenof_ultrasonic_direction () const
	Get maximum length of ultrasonic_direction value.
virtual Message *	clone () const
	Clone this message.

---

Detailed Description

StartUltrasonicMessage Fawkes BlackBoard Interface Message.

---

Constructor & Destructor Documentation

fawkes::NaoSensorInterface::StartUltrasonicMessage::StartUltrasonicMessage

(

const UltrasonicDirection

ini_ultrasonic_direction

)

Constructor with initial values.

Parameters:

ini_ultrasonic_direction

initial value for ultrasonic_direction

Definition at line 1400 of file NaoSensorInterface.cpp.

References fawkes::Message::data_size, fawkes::Message::data_ptr, fawkes::Message::data_ts, fawkes::NaoSensorInterface::StartUltrasonicMessage::StartUltrasonicMessage_data_t::ultrasonic_direction, fawkes::Message::add_fieldinfo(), and fawkes::IFT_ENUM.

fawkes::NaoSensorInterface::StartUltrasonicMessage::StartUltrasonicMessage

(

)

Constructor.

Definition at line 1411 of file NaoSensorInterface.cpp.

References fawkes::Message::data_size, fawkes::Message::data_ptr, fawkes::Message::data_ts, fawkes::Message::add_fieldinfo(), fawkes::IFT_ENUM, and fawkes::NaoSensorInterface::StartUltrasonicMessage::StartUltrasonicMessage_data_t::ultrasonic_direction.

fawkes::NaoSensorInterface::StartUltrasonicMessage::~StartUltrasonicMessage

(

)

Destructor.

Definition at line 1422 of file NaoSensorInterface.cpp.

References fawkes::Interface::data_ptr.

fawkes::NaoSensorInterface::StartUltrasonicMessage::StartUltrasonicMessage

(

const StartUltrasonicMessage *

m

)

Copy constructor.

Parameters:

m	message to copy from

Definition at line 1430 of file NaoSensorInterface.cpp.

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

---

Member Function Documentation

Message * fawkes::NaoSensorInterface::StartUltrasonicMessage::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 1480 of file NaoSensorInterface.cpp.

size_t fawkes::NaoSensorInterface::StartUltrasonicMessage::maxlenof_ultrasonic_direction

(

)

const

Get maximum length of ultrasonic_direction value.

Returns:

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

Definition at line 1457 of file NaoSensorInterface.cpp.

void fawkes::NaoSensorInterface::StartUltrasonicMessage::set_ultrasonic_direction

(

const UltrasonicDirection

new_ultrasonic_direction

)

Set ultrasonic_direction value.

Direction that was used to gather the ultrasonic readings.

Parameters:

new_ultrasonic_direction

new ultrasonic_direction value

Definition at line 1469 of file NaoSensorInterface.cpp.

References fawkes::NaoSensorInterface::NaoSensorInterface_data_t::ultrasonic_direction.

NaoSensorInterface::UltrasonicDirection fawkes::NaoSensorInterface::StartUltrasonicMessage::ultrasonic_direction

(

)

const

Get ultrasonic_direction value.

Direction that was used to gather the ultrasonic readings.

Returns:

ultrasonic_direction value

Definition at line 1447 of file NaoSensorInterface.cpp.

References fawkes::NaoSensorInterface::NaoSensorInterface_data_t::ultrasonic_direction.

---

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

• src/libs/interfaces/NaoSensorInterface.h
• src/plugins/nao/interfaces/NaoSensorInterface.cpp