fawkes::NavigatorInterface::SetSecurityDistanceMessage Class Reference

SetSecurityDistanceMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::NavigatorInterface::SetSecurityDistanceMessage:

Public Member Functions
	SetSecurityDistanceMessage (const float ini_security_distance)
	Constructor with initial values. More...
	SetSecurityDistanceMessage ()
	Constructor. More...
	~SetSecurityDistanceMessage ()
	Destructor. More...
	SetSecurityDistanceMessage (const SetSecurityDistanceMessage *m)
	Copy constructor. More...
float	security_distance () const
	Get security_distance value. More...
void	set_security_distance (const float new_security_distance)
	Set security_distance value. More...
size_t	maxlenof_security_distance () const
	Get maximum length of security_distance value. More...
virtual Message *	clone () const
	Clone this message. More...
Public Member Functions inherited from fawkes::Message
	Message (const char *type)
	Constructor. More...
	Message (const Message *mesg)
	Copy constructor. More...
	Message (const Message &mesg)
	Copy constructor. More...
virtual	~Message ()
	Destructor. More...
Message &	operator= (const Message &m)
	Assign this message to given message. More...
unsigned int	id () const
	Get message ID. More...
void	set_id (unsigned int message_id)
	Set message ID. More...
void	mark_enqueued ()
	Mark message as being enqueued. More...
bool	enqueued () const
	Check is message has been enqueued. More...
const Time *	time_enqueued () const
	Get time when message was enqueued. More...
unsigned int	sender_id () const
	Get ID of sender. More...
const char *	sender_thread_name () const
	Get sender of message. More...
Interface *	interface () const
	Get transmitting interface. More...
const char *	type () const
	Get message type. More...
InterfaceFieldIterator	fields ()
	Get iterator over all fields of this interface instance. More...
InterfaceFieldIterator	fields_end ()
	Invalid iterator. More...
unsigned int	num_fields () const
	Get the number of fields in the message. More...
const void *	datachunk () const
	Get pointer to data. More...
unsigned int	datasize () const
	Get size of data. More...
unsigned int	hops () const
	Get number of hops. More...
void	set_hops (unsigned int hops)
	Set number of hops. More...
void	set_from_chunk (const void *chunk)
	Set from raw data chunk. More...
unsigned int	recipient () const
	Get recipient memory serial. More...
template<class MessageType >
bool	is_of_type ()
	Check if message has desired type. More...
Public Member Functions inherited from fawkes::RefCount
	RefCount ()
	Constructor. More...
virtual	~RefCount ()
	Destructor. More...
void	ref ()
	Increment reference count. More...
void	unref ()
	Decrement reference count and conditionally delete this instance. More...
unsigned int	refcount ()
	Get reference count for this instance. More...

Additional Inherited Members
Protected Member Functions inherited from fawkes::Message
void	add_fieldinfo (interface_fieldtype_t type, const char *name, size_t length, void *value, const char *enumtype=0)
	Add an entry to the info list. More...
Protected Attributes inherited from fawkes::Message
void *	data_ptr
	Pointer to memory that contains local data. More...
unsigned int	data_size
	Size of memory needed to hold all data. More...
message_data_ts_t *	data_ts
	data timestamp aliasing pointer More...

Detailed Description

SetSecurityDistanceMessage Fawkes BlackBoard Interface Message.

Definition at line 352 of file NavigatorInterface.h.

Constructor & Destructor Documentation

fawkes::NavigatorInterface::SetSecurityDistanceMessage::SetSecurityDistanceMessage

(

const float

ini_security_distance

)

Constructor with initial values.

Parameters

ini_security_distance

initial value for security_distance

Definition at line 1567 of file NavigatorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.

fawkes::NavigatorInterface::SetSecurityDistanceMessage::SetSecurityDistanceMessage

(

)

Constructor.

Definition at line 1578 of file NavigatorInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, and fawkes::IFT_FLOAT.

fawkes::NavigatorInterface::SetSecurityDistanceMessage::~SetSecurityDistanceMessage

(

)

Destructor.

Definition at line 1589 of file NavigatorInterface.cpp.

References fawkes::Message::data_ptr.

fawkes::NavigatorInterface::SetSecurityDistanceMessage::SetSecurityDistanceMessage

(

const SetSecurityDistanceMessage *

m

)

Copy constructor.

Parameters

m	message to copy from

Definition at line 1597 of file NavigatorInterface.cpp.

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

Member Function Documentation

Message * fawkes::NavigatorInterface::SetSecurityDistanceMessage::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 1645 of file NavigatorInterface.cpp.

size_t fawkes::NavigatorInterface::SetSecurityDistanceMessage::maxlenof_security_distance

(

)

const

Get maximum length of security_distance value.

Returns

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

Definition at line 1623 of file NavigatorInterface.cpp.

float fawkes::NavigatorInterface::SetSecurityDistanceMessage::security_distance

(

)

const

Get security_distance value.

Security distance to keep to obstacles

Returns

security_distance value

Definition at line 1613 of file NavigatorInterface.cpp.

void fawkes::NavigatorInterface::SetSecurityDistanceMessage::set_security_distance

(

const float

new_security_distance

)

Set security_distance value.

Security distance to keep to obstacles

Parameters

new_security_distance

new security_distance value

Definition at line 1634 of file NavigatorInterface.cpp.

---

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

• src/libs/interfaces/NavigatorInterface.h
• src/libs/interfaces/NavigatorInterface.cpp