SetKickoffMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::GameStateInterface::SetKickoffMessage:

Public Member Functions
	SetKickoffMessage (const bool ini_kickoff)
	Constructor with initial values. More...

	SetKickoffMessage ()
	Constructor. More...

	~SetKickoffMessage ()
	Destructor. More...

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

bool	is_kickoff () const
	Get kickoff value. More...

void	set_kickoff (const bool new_kickoff)
	Set kickoff value. More...

size_t	maxlenof_kickoff () const
	Get maximum length of kickoff 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

SetKickoffMessage Fawkes BlackBoard Interface Message.

Definition at line 154 of file GameStateInterface.h.

Constructor & Destructor Documentation

◆ SetKickoffMessage() [1/3]

fawkes::GameStateInterface::SetKickoffMessage::SetKickoffMessage ( const bool ini_kickoff )

Constructor with initial values.

Parameters

ini_kickoff initial value for kickoff

Definition at line 623 of file GameStateInterface.cpp.

◆ SetKickoffMessage() [2/3]

fawkes::GameStateInterface::SetKickoffMessage::SetKickoffMessage ( )

◆ ~SetKickoffMessage()

fawkes::GameStateInterface::SetKickoffMessage::~SetKickoffMessage ( )

Destructor.

Definition at line 671 of file GameStateInterface.cpp.

References fawkes::Interface::data_ptr.

◆ SetKickoffMessage() [3/3]

fawkes::GameStateInterface::SetKickoffMessage::SetKickoffMessage ( const SetKickoffMessage * m )

explicit

Copy constructor.

Parameters

m	message to copy from

Definition at line 679 of file GameStateInterface.cpp.

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

Member Function Documentation

◆ clone()

Message * fawkes::GameStateInterface::SetKickoffMessage::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 725 of file GameStateInterface.cpp.

◆ is_kickoff()

bool fawkes::GameStateInterface::SetKickoffMessage::is_kickoff ( ) const

Get kickoff value.

Whether we have kickoff

Returns: kickoff value

Definition at line 694 of file GameStateInterface.cpp.

Referenced by RefBoxCommThread::loop().

◆ maxlenof_kickoff()

size_t fawkes::GameStateInterface::SetKickoffMessage::maxlenof_kickoff ( ) const

Get maximum length of kickoff value.

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

Definition at line 704 of file GameStateInterface.cpp.

◆ set_kickoff()

void fawkes::GameStateInterface::SetKickoffMessage::set_kickoff ( const bool new_kickoff )

Set kickoff value.

Whether we have kickoff

Parameters

new_kickoff new kickoff value

Definition at line 714 of file GameStateInterface.cpp.

References fawkes::change_field().

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

src/libs/interfaces/GameStateInterface.h
src/libs/interfaces/GameStateInterface.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SetKickoffMessage() [1/3]

◆ SetKickoffMessage() [2/3]

◆ ~SetKickoffMessage()

◆ SetKickoffMessage() [3/3]

Member Function Documentation

◆ clone()

◆ is_kickoff()

◆ maxlenof_kickoff()

◆ set_kickoff()