AdvertiseOptions Class Reference

A class for customizing the publication options for a topic or service advertised. E.g.: Set the scope of a topic/service. More...

#include <AdvertiseOptions.hh>

Public Member Functions
	AdvertiseOptions ()
	Constructor.
	AdvertiseOptions (const AdvertiseOptions &_other)
	Copy constructor.
virtual	~AdvertiseOptions ()
	Destructor.
bool	operator!= (const AdvertiseOptions &_other) const
	Inequality operator. This function checks if the given options do not have identical values to this object.
AdvertiseOptions &	operator= (const AdvertiseOptions &_other)
	Assignment operator.
bool	operator== (const AdvertiseOptions &_other) const
	Equality operator. This function checks if the given AdvertiseOptions has identical content to this object.
const Scope_t &	Scope () const
	Get the scope used in this topic/service.
void	SetScope (const Scope_t &_scope)
	Set the scope of the topic or service.

Detailed Description

A class for customizing the publication options for a topic or service advertised. E.g.: Set the scope of a topic/service.

gz/transport/AdvertiseOptions.hh

Constructor & Destructor Documentation

AdvertiseOptions() [1/2]

AdvertiseOptions

(

)

Constructor.

AdvertiseOptions() [2/2]

AdvertiseOptions

(

const AdvertiseOptions &

_other

)

Copy constructor.

Parameters

[in]

_other

AdvertiseOptions to copy.

~AdvertiseOptions()

virtual ~AdvertiseOptions ( )

virtual

Destructor.

Member Function Documentation

operator!=()

bool operator!=

(

const AdvertiseOptions &

_other

)

const

Inequality operator. This function checks if the given options do not have identical values to this object.

Parameters

[in]

_other

The options to compare against.

Returns

True if this object does not match the provided object.

operator=()

AdvertiseOptions & operator=

(

const AdvertiseOptions &

_other

)

Assignment operator.

Parameters

[in]

_other

The new AdvertiseOptions.

Returns

A reference to this instance.

operator==()

bool operator==

(

const AdvertiseOptions &

_other

)

const

Equality operator. This function checks if the given AdvertiseOptions has identical content to this object.

Parameters

[in]

_other

The options to compare against.

Returns

True if this object matches the provided object.

Scope()

const Scope_t & Scope

(

)

const

Get the scope used in this topic/service.

Returns

The scope.

See also

SetScope.

Scope_t.

SetScope()

void SetScope

(

const Scope_t &

_scope

)

Set the scope of the topic or service.

Parameters

[in]

_scope

The new scope.

See also

Scope.

Scope_t.

---

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

• AdvertiseOptions.hh