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. 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... | |
| AdvertiseOptions & | operator= (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_t & | Scope () 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 topic or service advertised. E.g.: Set the scope of a topic/service.
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 |
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 |
◆ SetScope()
| void SetScope | ( | const Scope_t & | _scope | ) |
The documentation for this class was generated from the following file: