ignition/transport/AdvertiseOptions.hh
More...
#include <AdvertiseOptions.hh>
ignition/transport/AdvertiseOptions.hh
A class for customizing the publication options for a topic or service advertised. E.g.: Set the scope of a topic/service.
◆ AdvertiseOptions() [1/2]
ignition::transport::AdvertiseOptions::AdvertiseOptions |
( |
| ) |
|
◆ AdvertiseOptions() [2/2]
ignition::transport::AdvertiseOptions::AdvertiseOptions |
( |
const AdvertiseOptions & |
_other | ) |
|
Copy constructor.
- Parameters
-
◆ ~AdvertiseOptions()
virtual ignition::transport::AdvertiseOptions::~AdvertiseOptions |
( |
| ) |
|
|
virtual |
◆ MsgLength()
size_t ignition::transport::AdvertiseOptions::MsgLength |
( |
| ) |
const |
Get the total length of the message.
- Returns
- Return the length of the message in bytes.
◆ operator!=()
bool ignition::transport::AdvertiseOptions::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=()
Assignment operator.
- Parameters
-
- Returns
- A reference to this instance.
◆ operator==()
bool ignition::transport::AdvertiseOptions::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.
◆ Pack()
size_t ignition::transport::AdvertiseOptions::Pack |
( |
char * |
_buffer | ) |
const |
Serialize the options.
The caller has ownership of the buffer and is responsible for its [de]allocation.
- Parameters
-
[out] | _buffer | Destination buffer in which the options will be serialized. |
- Returns
- Number of bytes serialized.
◆ Scope()
const Scope_t& ignition::transport::AdvertiseOptions::Scope |
( |
| ) |
const |
Get the scope used in this topic/service.
- Returns
- The scope.
- See also
- SetScope.
-
Scope_t.
◆ SetScope()
void ignition::transport::AdvertiseOptions::SetScope |
( |
const Scope_t & |
_scope | ) |
|
Set the scope of the topic or service.
- Parameters
-
- See also
- Scope.
-
Scope_t.
◆ Unpack()
size_t ignition::transport::AdvertiseOptions::Unpack |
( |
const char * |
_buffer | ) |
|
Deserialize and set the options.
The input buffer is unpacked and used to set this object's options.
- Parameters
-
[in] | _buffer | Input buffer with the data to be deserialized. |
◆ operator<<
std::ostream& operator<< |
( |
std::ostream & |
_out, |
|
|
const AdvertiseOptions & |
_other |
|
) |
| |
|
friend |
Stream insertion operator.
- Parameters
-
The documentation for this class was generated from the following file: