ctd::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_id, const std::string &receiver_thread_id, const std::string &m_data)
	Constructor setting information about the message (to be send). More...
	~Message ()
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	Print (const uint16_t truncate=128) const
	Generate ASCII output providing a status of the object. More...
Message &	operator= (const Message &source)
	Message ()
	Message (const Message &source)
	Message (const std::string &command, const uint8_t priority, const std::string &sender_thread_id, const std::string &receiver_thread_id, const std::string &m_data)
	Constructor setting information about the message (to be send). More...
	~Message ()
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	Print (const uint16_t truncate=128) const
	Generate ASCII output providing a status of the object. More...
Message &	operator= (const Message &source)
	Message ()
	Message (const Message &source)
	Message (const std::string &command, const uint8_t priority, const std::string &sender_thread_id, const std::string &receiver_thread_id, const std::string &m_data)
	Constructor setting information about the message (to be send). More...
	~Message ()
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	Print (const uint16_t truncate=128) const
	Generate ASCII output providing a status of the object. More...
Message &	operator= (const Message &source)

Protected Attributes
std::string	m_command
uint8_t	m_priority
std::string	m_sender_thread_id
std::string	m_receiver_thread_id
std::string	m_data
double	m_submission_time
double	m_reception_time

Detailed Description

IFW CTD Multiprocessing Toolkit Message class.

Constructor & Destructor Documentation

ctd::mptk::Message::Message

(

)

ctd::mptk::Message::Message

(

const Message &

source

)

ctd::mptk::Message::Message	(	const std::string &	command,
		const uint8_t	priority,
		const std::string &	sender_thread_id,
		const std::string &	receiver_thread_id,
		const std::string &	m_data
	)

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

ctd::mptk::Message::~Message

(

)

ctd::mptk::Message::Message

(

)

ctd::mptk::Message::Message

(

const Message &

source

)

ctd::mptk::Message::Message	(	const std::string &	command,
		const uint8_t	priority,
		const std::string &	sender_thread_id,
		const std::string &	receiver_thread_id,
		const std::string &	m_data
	)

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

ctd::mptk::Message::~Message

(

)

ctd::mptk::Message::Message

(

)

ctd::mptk::Message::Message

(

const Message &

source

)

ctd::mptk::Message::Message	(	const std::string &	command,
		const uint8_t	priority,
		const std::string &	sender_thread_id,
		const std::string &	receiver_thread_id,
		const std::string &	m_data
	)

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

ctd::mptk::Message::~Message

(

)

Member Function Documentation

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

(

)

const

Return name of command in object.

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

(

)

const

Return name of command in object.

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

(

)

const

Return name of command in object.

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

(

)

const

Return data (payload) of message.

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

(

)

const

Return data (payload) of message.

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

(

)

const

Return data (payload) of message.

Message& ctd::mptk::Message::operator=

(

const Message &

source

)

Message & ctd::mptk::Message::operator=

(

const Message &

source

)

Message& ctd::mptk::Message::operator=

(

const Message &

source

)

std::string ctd::mptk::Message::Print

(

const uint16_t

truncate = 128

)

const

Generate ASCII output providing a status of the object.

std::string ctd::mptk::Message::Print

(

const uint16_t

truncate = 128

)

const

Generate ASCII output providing a status of the object.

std::string ctd::mptk::Message::Print

(

const uint16_t

truncate = 128

)

const

Generate ASCII output providing a status of the object.

uint8_t ctd::mptk::Message::Priority

(

)

const

Return priotity of message (message queue priority).

uint8_t ctd::mptk::Message::Priority

(

)

const

Return priotity of message (message queue priority).

uint8_t ctd::mptk::Message::Priority

(

)

const

Return priotity of message (message queue priority).

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

(

)

const

Return receiver Thread ID.

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

(

)

const

Return receiver Thread ID.

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

(

)

const

Return receiver Thread ID.

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

(

)

const

Return sender Thread ID.

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

(

)

const

Return sender Thread ID.

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

(

)

const

Return sender Thread ID.

void ctd::mptk::Message::SetReceptionTime

(

const double

timestamp

)

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

void ctd::mptk::Message::SetReceptionTime

(

const double

timestamp

)

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

void ctd::mptk::Message::SetReceptionTime

(

const double

timestamp

)

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

Member Data Documentation

std::string ctd::mptk::Message::m_command

protected

std::string ctd::mptk::Message::m_data

protected

uint8_t ctd::mptk::Message::m_priority

protected

std::string ctd::mptk::Message::m_receiver_thread_id

protected

double ctd::mptk::Message::m_reception_time

protected

std::string ctd::mptk::Message::m_sender_thread_id

protected

double ctd::mptk::Message::m_submission_time

protected

---

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

• ctd/mptk/src/include/ctd/mptk/Message.hpp
• INTROOT/include/ctd/mptk/Message.hpp
• INTROOT/sources/ctd/mptk/src/include/ctd/mptk/Message.hpp
• ctd/mptk/src/Message.cpp
• INTROOT/sources/ctd/mptk/src/Message.cpp