Gazebo Transport

API Reference

11.4.1
AdvertiseServiceOptions Class Reference

A class for customizing the publication options for a service advertised. More...

#include <AdvertiseOptions.hh>

Public Member Functions

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

Detailed Description

A class for customizing the publication options for a service advertised.

Constructor & Destructor Documentation

◆ AdvertiseServiceOptions() [1/2]

Constructor.

◆ AdvertiseServiceOptions() [2/2]

Copy constructor.

Parameters
[in]_otherAdvertiseServiceOptions to copy.

◆ ~AdvertiseServiceOptions()

virtual ~AdvertiseServiceOptions ( )
virtual

Destructor.

Member Function Documentation

◆ operator!=()

bool operator!= ( const AdvertiseServiceOptions _other) const

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

Parameters
[in]_otherThe options to compare against.
Returns
True if this object does not match the provided object.

◆ operator=()

AdvertiseServiceOptions& operator= ( const AdvertiseServiceOptions _other)

Assignment operator.

Parameters
[in]_otherThe other AdvertiseServiceOptions.
Returns
A reference to this instance.

◆ operator==()

bool operator== ( const AdvertiseServiceOptions _other) const

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

Parameters
[in]_otherThe options to compare against.
Returns
True if this object matches the provided object.

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