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... | |
| size_t | MsgLength () const |
| Get the total length of the message. 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... | |
| AdvertiseServiceOptions & | operator= (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... | |
| size_t | Pack (char *_buffer) const |
| Serialize the options. The caller has ownership of the buffer and is responsible for its [de]allocation. More... | |
| size_t | Unpack (const char *_buffer) |
| Unserialize the options. More... | |
 Public Member Functions inherited from AdvertiseOptions | |
| AdvertiseOptions () | |
| Constructor. More... | |
| AdvertiseOptions (const AdvertiseOptions &_other) | |
| Copy constructor. More... | |
| virtual | ~AdvertiseOptions () |
| Destructor. More... | |
| size_t | MsgLength () const |
| Get the total length of the message. 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... | |
| size_t | Pack (char *_buffer) const |
| Serialize the options. The caller has ownership of the buffer and is responsible for its [de]allocation. 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... | |
| size_t | Unpack (const char *_buffer) |
| Deserialize and set the options. The input buffer is unpacked and used to set this object's options. More... | |
Detailed Description
A class for customizing the publication options for a service advertised.
Constructor & Destructor Documentation
◆ AdvertiseServiceOptions() [1/2]
Constructor.
◆ AdvertiseServiceOptions() [2/2]
| AdvertiseServiceOptions | ( | const AdvertiseServiceOptions & | _other | ) |
Copy constructor.
- Parameters
-
[in] _other AdvertiseServiceOptions to copy.
◆ ~AdvertiseServiceOptions()
|
virtual |
Destructor.
Member Function Documentation
◆ MsgLength()
| size_t MsgLength | ( | ) | const |
Get the total length of the message.
- Returns
- Return the length of the message in bytes.
◆ 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] _other The 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] _other The 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] _other The options to compare against.
- Returns
- True if this object matches the provided object.
◆ Pack()
| size_t 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.
◆ Unpack()
| size_t Unpack | ( | const char * | _buffer | ) |
Unserialize the options.
- Parameters
-
[in] _buffer Input buffer with the data to be unserialized.
The documentation for this class was generated from the following file: