SetDigitalOutputMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::RobotinoSensorInterface::SetDigitalOutputMessage:

Public Member Functions
	SetDigitalOutputMessage (const uint8_t ini_digital_out, const bool ini_enabled)
	Constructor with initial values. More...

	SetDigitalOutputMessage ()
	Constructor. More...

	~SetDigitalOutputMessage ()
	Destructor. More...

	SetDigitalOutputMessage (const SetDigitalOutputMessage *m)
	Copy constructor. More...

uint8_t	digital_out () const
	Get digital_out value. More...

void	set_digital_out (const uint8_t new_digital_out)
	Set digital_out value. More...

size_t	maxlenof_digital_out () const
	Get maximum length of digital_out value. More...

bool	is_enabled () const
	Get enabled value. More...

void	set_enabled (const bool new_enabled)
	Set enabled value. More...

size_t	maxlenof_enabled () const
	Get maximum length of enabled 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...

template<class MessageType >
MessageType *	as_type ()
	Cast message to given type if possible. 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, const interface_enum_map_t enum_map=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

SetDigitalOutputMessage Fawkes BlackBoard Interface Message.

Definition at line 91 of file RobotinoSensorInterface.h.

Constructor & Destructor Documentation

◆ SetDigitalOutputMessage() [1/3]

fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::SetDigitalOutputMessage	(	const uint8_t	ini_digital_out,
		const bool	ini_enabled
	)

Constructor with initial values.

Parameters

ini_digital_out	initial value for digital_out
ini_enabled	initial value for enabled

Definition at line 664 of file RobotinoSensorInterface.cpp.

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

◆ SetDigitalOutputMessage() [2/3]

fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::SetDigitalOutputMessage ( )

Constructor.

Definition at line 677 of file RobotinoSensorInterface.cpp.

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

◆ ~SetDigitalOutputMessage()

fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::~SetDigitalOutputMessage ( )

Destructor.

Definition at line 689 of file RobotinoSensorInterface.cpp.

References fawkes::Interface::data_ptr.

◆ SetDigitalOutputMessage() [3/3]

fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::SetDigitalOutputMessage ( const SetDigitalOutputMessage * m )

explicit

Copy constructor.

Parameters

m	message to copy from

Definition at line 697 of file RobotinoSensorInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::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 781 of file RobotinoSensorInterface.cpp.

◆ digital_out()

uint8_t fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::digital_out ( ) const

Get digital_out value.

    The number of the digital output to set.

Returns: digital_out value

Definition at line 714 of file RobotinoSensorInterface.cpp.

◆ is_enabled()

bool fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::is_enabled ( ) const

Get enabled value.

True to enable digital out, false to disable.

Returns: enabled value

Definition at line 748 of file RobotinoSensorInterface.cpp.

◆ maxlenof_digital_out()

size_t fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::maxlenof_digital_out ( ) const

Get maximum length of digital_out value.

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

Definition at line 724 of file RobotinoSensorInterface.cpp.

◆ maxlenof_enabled()

size_t fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::maxlenof_enabled ( ) const

Get maximum length of enabled value.

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

Definition at line 758 of file RobotinoSensorInterface.cpp.

◆ set_digital_out()

void fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::set_digital_out ( const uint8_t new_digital_out )

Set digital_out value.

    The number of the digital output to set.

Parameters

new_digital_out new digital_out value

Definition at line 736 of file RobotinoSensorInterface.cpp.

References fawkes::change_field().

◆ set_enabled()

void fawkes::RobotinoSensorInterface::SetDigitalOutputMessage::set_enabled ( const bool new_enabled )

Set enabled value.

True to enable digital out, false to disable.

Parameters

new_enabled new enabled value

Definition at line 770 of file RobotinoSensorInterface.cpp.

References fawkes::change_field().

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

src/libs/interfaces/RobotinoSensorInterface.h
src/plugins/robotino/interfaces/RobotinoSensorInterface.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SetDigitalOutputMessage() [1/3]

◆ SetDigitalOutputMessage() [2/3]

◆ ~SetDigitalOutputMessage()

◆ SetDigitalOutputMessage() [3/3]

Member Function Documentation

◆ clone()

◆ digital_out()

◆ is_enabled()

◆ maxlenof_digital_out()

◆ maxlenof_enabled()

◆ set_digital_out()

◆ set_enabled()