MessageInfo Class Reference

A class that provides information about the message received. More...

#include <MessageInfo.hh>

Public Member Functions
	MessageInfo ()
	Default constructor.
	MessageInfo (const MessageInfo &_other)
	Explicit copy constructor (The copy constructor is deleted by default due to the use of std::unique_ptr member).
	MessageInfo (MessageInfo &&_other)
	Move constructor.
	~MessageInfo ()
	Destructor.
bool	IntraProcess () const
	Whether the message is coming from a node within this process.
const std::string &	Partition () const
	Get the name of the partition.
void	SetIntraProcess (bool _value)
	Set whether this message is intra-process or not.
void	SetPartition (const std::string &_partition)
	Set the partition of the topic the message was on.
void	SetTopic (const std::string &_topic)
	Set the topic name associated to the message.
bool	SetTopicAndPartition (const std::string &_fullyQualifiedName)
	Set both the topic and the partition from a single string.
void	SetType (const std::string &_type)
	Set the name of the message type.
const std::string &	Topic () const
	Get the topic name associated to the message.
const std::string &	Type () const
	Get the name of the message type.

Protected Attributes
std::unique_ptr< MessageInfoPrivate >	dataPtr

Detailed Description

A class that provides information about the message received.

Constructor & Destructor Documentation

MessageInfo() [1/3]

MessageInfo

(

)

Default constructor.

MessageInfo() [2/3]

MessageInfo

(

const MessageInfo &

_other

)

Explicit copy constructor (The copy constructor is deleted by default due to the use of std::unique_ptr member).

Parameters

[in]

_other

an instance to copy data from

MessageInfo() [3/3]

MessageInfo

(

MessageInfo &&

_other

)

Move constructor.

Parameters

[in]

_other

an instance data is moved from

~MessageInfo()

~MessageInfo

(

)

Destructor.

Member Function Documentation

IntraProcess()

bool IntraProcess

(

)

const

Whether the message is coming from a node within this process.

Returns

True when intra-process, false otherwise.

Partition()

const std::string & Partition

(

)

const

Get the name of the partition.

Returns

The partition name.

SetIntraProcess()

void SetIntraProcess

(

bool

_value

)

Set whether this message is intra-process or not.

Parameters

[in]

_value

The intra-process value.

SetPartition()

void SetPartition

(

const std::string &

_partition

)

Set the partition of the topic the message was on.

Parameters

[in]

_partition

of the topic.

SetTopic()

void SetTopic

(

const std::string &

_topic

)

Set the topic name associated to the message.

SetTopicAndPartition()

bool SetTopicAndPartition

(

const std::string &

_fullyQualifiedName

)

Set both the topic and the partition from a single string.

Parameters

[in]

_fullyQualifiedName

The topic string with the partition information included.

Returns

true if the topic and partition were set

See also

TopicUtils::FullyQualifiedName

SetType()

void SetType

(

const std::string &

_type

)

Set the name of the message type.

Parameters

[in]

_type

the type name to set.

Topic()

const std::string & Topic

(

)

const

Get the topic name associated to the message.

Returns

The topic name.

Type()

const std::string & Type

(

)

const

Get the name of the message type.

Returns

The message type name.

Member Data Documentation

dataPtr

std::unique_ptr<MessageInfoPrivate> dataPtr

protected

---

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

• MessageInfo.hh