ccf::mptk::Message Class Reference

IFW CTD Multiprocessing Toolkit Message class. More...

#include <message.hpp>

Public Member Functions
	Message ()
	Message (const Message &source)
	Message (const std::string &command, const uint8_t priority, const std::string &sender_thread_name, const std::string &receiver_thread_name, const std::string &m_data)
	Constructor setting information about the message (to be send). More...
	~Message ()
void	Clear ()
	Clear message object. More...
const std::string &	GetMsgId () const
	Return unique ID assigned to the message. More...
const std::string &	Command () const
	Return name of command in object. More...
uint8_t	Priority () const
	Return priotity of message (message queue priority). More...
const std::string &	SenderThreadId () const
	Return sender Thread ID. More...
const std::string &	ReceiverThreadId () const
	Return receiver Thread ID. More...
const std::string &	Data () const
	Return data (payload) of message. More...
void	SetReceptionTime (const double timestamp)
	Set the time of receiving the message from the Message Bus. More...
std::string	ToString (const uint16_t truncate=128, const bool compact=true) const
	Generate ASCII output providing a status of the object. More...
Message &	operator= (const Message &source)

Protected Attributes
std::string	m_id
std::string	m_command
uint8_t	m_priority
std::string	m_sender_thread_name
std::string	m_receiver_thread_name
std::string	m_data
double	m_submission_time
double	m_reception_time

Detailed Description

IFW CTD Multiprocessing Toolkit Message class.

The MPTK Message class is used to transfer information between MPTK Threads.

Constructor & Destructor Documentation

Message() [1/3]

ccf::mptk::Message::Message

(

)

Message() [2/3]

ccf::mptk::Message::Message

(

const Message &

source

)

Message() [3/3]

ccf::mptk::Message::Message	(	const std::string &	command,
		const uint8_t	priority,
		const std::string &	sender_thread_name,
		const std::string &	receiver_thread_name,
		const std::string &	m_data
	)

Constructor setting information about the message (to be send).

~Message()

ccf::mptk::Message::~Message

(

)

Member Function Documentation

Clear()

void ccf::mptk::Message::Clear

(

)

Clear message object.

Command()

const std::string & ccf::mptk::Message::Command

(

)

const

Return name of command in object.

Data()

const std::string & ccf::mptk::Message::Data

(

)

const

Return data (payload) of message.

GetMsgId()

const std::string & ccf::mptk::Message::GetMsgId

(

)

const

Return unique ID assigned to the message.

operator=()

Message & ccf::mptk::Message::operator=

(

const Message &

source

)

Priority()

uint8_t ccf::mptk::Message::Priority

(

)

const

Return priotity of message (message queue priority).

ReceiverThreadId()

const std::string & ccf::mptk::Message::ReceiverThreadId

(

)

const

Return receiver Thread ID.

SenderThreadId()

const std::string & ccf::mptk::Message::SenderThreadId

(

)

const

Return sender Thread ID.

SetReceptionTime()

void ccf::mptk::Message::SetReceptionTime

(

const double

timestamp

)

Set the time of receiving the message from the Message Bus.

ToString()

std::string ccf::mptk::Message::ToString	(	const uint16_t	truncate = 128,
		const bool	compact = true
	)		const

Generate ASCII output providing a status of the object.

Member Data Documentation

m_command

std::string ccf::mptk::Message::m_command

protected

m_data

std::string ccf::mptk::Message::m_data

protected

m_id

std::string ccf::mptk::Message::m_id

protected

m_priority

uint8_t ccf::mptk::Message::m_priority

protected

m_receiver_thread_name

std::string ccf::mptk::Message::m_receiver_thread_name

protected

m_reception_time

double ccf::mptk::Message::m_reception_time

protected

m_sender_thread_name

std::string ccf::mptk::Message::m_sender_thread_name

protected

m_submission_time

double ccf::mptk::Message::m_submission_time

protected

---

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

• mptk/src/include/ccf/mptk/message.hpp
• mptk/src/message.cpp