Fawkes API Fawkes Development Version
fawkes::TestInterface::CalculateMessage Class Reference

CalculateMessage Fawkes BlackBoard Interface Message. More...

#include <>>

Inheritance diagram for fawkes::TestInterface::CalculateMessage:

Public Member Functions

 CalculateMessage (const int32_t ini_summand, const int32_t ini_addend)
 Constructor with initial values. More...
 
 CalculateMessage ()
 Constructor. More...
 
 ~CalculateMessage ()
 Destructor. More...
 
 CalculateMessage (const CalculateMessage *m)
 Copy constructor. More...
 
int32_t summand () const
 Get summand value. More...
 
void set_summand (const int32_t new_summand)
 Set summand value. More...
 
size_t maxlenof_summand () const
 Get maximum length of summand value. More...
 
int32_t addend () const
 Get addend value. More...
 
void set_addend (const int32_t new_addend)
 Set addend value. More...
 
size_t maxlenof_addend () const
 Get maximum length of addend value. More...
 
virtual Messageclone () 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...
 
Messageoperator= (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 Timetime_enqueued () const
 Get time when message was enqueued. More...
 
Uuid sender_id () const
 Get ID of the immediate sender, not necessarily the creator of the message. More...
 
Uuid source_id () const
 Get ID of the original source of the message. More...
 
void set_sender_id (const Uuid &id)
 Set sender ID. More...
 
void set_source_id (const Uuid &id)
 Set source ID. More...
 
const char * sender_thread_name () const
 Get sender of message. More...
 
Interfaceinterface () 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...
 
virtual Messageclone () const
 Clone this message. 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...
 
template<class FieldT , class DataT >
void set_field (FieldT &field, DataT &data)
 Set a field. More...
 
template<class FieldT , class DataT >
void set_field (FieldT &field, unsigned int index, DataT &data)
 Set an array field at a given index. 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_tdata_ts
 data timestamp aliasing pointer More...
 

Detailed Description

CalculateMessage Fawkes BlackBoard Interface Message.

Definition at line 120 of file TestInterface.h.

Constructor & Destructor Documentation

◆ CalculateMessage() [1/3]

fawkes::TestInterface::CalculateMessage::CalculateMessage ( const int32_t  ini_summand,
const int32_t  ini_addend 
)

Constructor with initial values.

Parameters
ini_summandinitial value for summand
ini_addendinitial value for addend

Definition at line 511 of file TestInterface.cpp.

References fawkes::Message::add_fieldinfo(), fawkes::Message::data_ptr, fawkes::Message::data_size, fawkes::Message::data_ts, fawkes::IFT_INT32, fawkes::TestInterface::TEST_ENUM_1, and fawkes::TestInterface::TEST_ENUM_2.

◆ CalculateMessage() [2/3]

◆ ~CalculateMessage()

fawkes::TestInterface::CalculateMessage::~CalculateMessage ( )

Destructor.

Definition at line 540 of file TestInterface.cpp.

References fawkes::Interface::data_ptr.

◆ CalculateMessage() [3/3]

fawkes::TestInterface::CalculateMessage::CalculateMessage ( const CalculateMessage m)
explicit

Copy constructor.

Parameters
mmessage to copy from

Definition at line 548 of file TestInterface.cpp.

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

Member Function Documentation

◆ addend()

int32_t fawkes::TestInterface::CalculateMessage::addend ( ) const

Get addend value.

Addend

Returns
addend value

Definition at line 593 of file TestInterface.cpp.

Referenced by AgentControlThread::loop().

◆ clone()

Message * fawkes::TestInterface::CalculateMessage::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 624 of file TestInterface.cpp.

◆ maxlenof_addend()

size_t fawkes::TestInterface::CalculateMessage::maxlenof_addend ( ) const

Get maximum length of addend value.

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

Definition at line 603 of file TestInterface.cpp.

◆ maxlenof_summand()

size_t fawkes::TestInterface::CalculateMessage::maxlenof_summand ( ) const

Get maximum length of summand value.

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

Definition at line 573 of file TestInterface.cpp.

◆ set_addend()

void fawkes::TestInterface::CalculateMessage::set_addend ( const int32_t  new_addend)

Set addend value.

Addend

Parameters
new_addendnew addend value

Definition at line 613 of file TestInterface.cpp.

References fawkes::Interface::set_field().

◆ set_summand()

void fawkes::TestInterface::CalculateMessage::set_summand ( const int32_t  new_summand)

Set summand value.

Summand

Parameters
new_summandnew summand value

Definition at line 583 of file TestInterface.cpp.

References fawkes::Interface::set_field().

◆ summand()

int32_t fawkes::TestInterface::CalculateMessage::summand ( ) const

Get summand value.

Summand

Returns
summand value

Definition at line 563 of file TestInterface.cpp.

Referenced by AgentControlThread::loop().


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