Publisher Class Reference

This class stores all the information about a publisher. It stores the topic name that publishes, addresses, UUIDs, scope, etc. More...

#include <Publisher.hh>

Public Member Functions
	Publisher ()=default
	Default constructor. More...
	Publisher (const std::string &_topic, const std::string &_addr, const std::string &_pUuid, const std::string &_nUuid, const AdvertiseOptions &_opts)
	Constructor. More...
virtual	~Publisher ()=default
	Destructor. More...
std::string	Addr () const
	Get the ZeroMQ address of the publisher. More...
virtual void	FillDiscovery (msgs::Discovery &_msg) const
	Populate a discovery message. More...
std::string	NUuid () const
	Get the node UUID of the publisher. More...
bool	operator!= (const Publisher &_pub) const
	Inequality operator. This function checks if the given publisher does not have identical Topic, Addr, PUuid, NUuid, and Scope strings to this object. More...
bool	operator== (const Publisher &_pub) const
	Equality operator. This function checks if the given publisher has identical Topic, Addr, PUuid, NUuid, and Scope strings to this object. More...
virtual const AdvertiseOptions &	Options () const
	Get the advertised options. More...
std::string	PUuid () const
	Get the process UUID of the publisher. return Process UUID. More...
void	SetAddr (const std::string &_addr)
	Set ZeroMQ address of the publisher. More...
virtual void	SetFromDiscovery (const msgs::Discovery &_msg)
	Set data from a discovery message. More...
void	SetNUuid (const std::string &_nUuid)
	Set the node UUID of the publisher. More...
void	SetOptions (const AdvertiseOptions &_opts)
	Set the advertised options. More...
void	SetPUuid (const std::string &_pUuid)
	Set the process UUID of the publisher. More...
void	SetTopic (const std::string &_topic)
	Set the topic name published by this publisher. More...
std::string	Topic () const
	Get the topic published by this publisher. More...

Protected Attributes
std::string	addr
	ZeroMQ address of the publisher. More...
std::string	nUuid
	Node UUID of the publisher. More...
std::string	pUuid
	Process UUID of the publisher. More...
std::string	topic
	Topic name. More...

Detailed Description

This class stores all the information about a publisher. It stores the topic name that publishes, addresses, UUIDs, scope, etc.

ignition/transport/Publisher.hh

Constructor & Destructor Documentation

Publisher() [1/2]

Publisher ( )

default

Default constructor.

Publisher() [2/2]

Publisher	(	const std::string &	_topic,
		const std::string &	_addr,
		const std::string &	_pUuid,
		const std::string &	_nUuid,
		const AdvertiseOptions &	_opts
	)

Constructor.

Parameters

[in]	_topic	Topic name.
[in]	_addr	ZeroMQ address.
[in]	_pUuid	Process UUID.
[in]	_nUuid	node UUID.
[in]	_opts	The advertise options.

~Publisher()

virtual ~Publisher ( )

virtualdefault

Destructor.

Member Function Documentation

Addr()

std::string Addr

(

)

const

Get the ZeroMQ address of the publisher.

Returns

ZeroMQ address.

See also

SetAddr.

FillDiscovery()

virtual void FillDiscovery ( msgs::Discovery &  _msg ) const

virtual

Populate a discovery message.

Parameters

[in]

_msg

Message to fill.

Reimplemented in ServicePublisher, and MessagePublisher.

NUuid()

std::string NUuid

(

)

const

Get the node UUID of the publisher.

Returns

Node UUID.

See also

SetNUuid.

operator!=()

bool operator!=

(

const Publisher &

_pub

)

const

Inequality operator. This function checks if the given publisher does not have identical Topic, Addr, PUuid, NUuid, and Scope strings to this object.

Parameters

[in]

_pub

The publisher to compare against.

Returns

True if this object does not match the provided object.

operator==()

bool operator==

(

const Publisher &

_pub

)

const

Equality operator. This function checks if the given publisher has identical Topic, Addr, PUuid, NUuid, and Scope strings to this object.

Parameters

[in]

_pub

The publisher to compare against.

Returns

True if this object matches the provided object.

Options()

virtual const AdvertiseOptions& Options ( ) const

virtual

Get the advertised options.

Returns

The advertised options.

See also

SetOptions.

Reimplemented in ServicePublisher, and MessagePublisher.

PUuid()

std::string PUuid

(

)

const

Get the process UUID of the publisher. return Process UUID.

See also

SetPUuid.

SetAddr()

void SetAddr

(

const std::string &

_addr

)

Set ZeroMQ address of the publisher.

Parameters

[in]

_addr

New address.

See also

Addr.

SetFromDiscovery()

virtual void SetFromDiscovery ( const msgs::Discovery &  _msg )

virtual

Set data from a discovery message.

Parameters

[in]

_msg

Discovery message.

Reimplemented in ServicePublisher, and MessagePublisher.

SetNUuid()

void SetNUuid

(

const std::string &

_nUuid

)

Set the node UUID of the publisher.

Parameters

[in]

_nUuid

New node UUID.

See also

NUuid.

SetOptions()

void SetOptions

(

const AdvertiseOptions &

_opts

)

Set the advertised options.

Parameters

[in]

_opts

New advertised options.

See also

Options.

SetPUuid()

void SetPUuid

(

const std::string &

_pUuid

)

Set the process UUID of the publisher.

Parameters

[in]

_pUuid

New process UUID.

See also

PUuid.

SetTopic()

void SetTopic

(

const std::string &

_topic

)

Set the topic name published by this publisher.

Parameters

[in]

_topic

New topic name.

See also

Topic.

Topic()

std::string Topic

(

)

const

Get the topic published by this publisher.

Returns

Topic name.

See also

SetTopic.

Member Data Documentation

addr

std::string addr

protected

ZeroMQ address of the publisher.

nUuid

std::string nUuid

protected

Node UUID of the publisher.

pUuid

std::string pUuid

protected

Process UUID of the publisher.

topic

std::string topic

protected

Topic name.

---

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

• gz/transport/Publisher.hh