Ignition Transport

API Reference

11.0.0
AdvertiseMessageOptions Class Reference

A class for customizing the publication options for a topic advertised. E.g.: Set the rate of messages per second published. More...

#include <AdvertiseOptions.hh>

Public Member Functions

 AdvertiseMessageOptions ()
 Constructor. More...
 
 AdvertiseMessageOptions (const AdvertiseMessageOptions &_other)
 Copy constructor. More...
 
virtual ~AdvertiseMessageOptions ()
 Destructor. More...
 
uint64_t MsgsPerSec () const
 Get the maximum number of messages per second to be published. More...
 
bool operator!= (const AdvertiseMessageOptions &_other) const
 Inequality operator. This function checks if the given options do not have identical values to this object. More...
 
AdvertiseMessageOptionsoperator= (const AdvertiseMessageOptions &_other)
 Assignment operator. More...
 
bool operator== (const AdvertiseMessageOptions &_other) const
 Equality operator. This function checks if the given AdvertiseMessageOptions has identical content to this object. More...
 
void SetMsgsPerSec (const uint64_t _newMsgsPerSec)
 Set the maximum number of messages per second to be published. Note that we calculate the minimum period of a message based on the msgs/sec rate. Any message sent since the last Publish() and the duration of the period will be discarded. More...
 
bool Throttled () const
 Whether the publication has been throttled. 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...
 

Friends

std::ostreamoperator<< (std::ostream &_out, const AdvertiseMessageOptions &_other)
 Stream insertion operator. More...
 

Detailed Description

A class for customizing the publication options for a topic advertised. E.g.: Set the rate of messages per second published.

Constructor & Destructor Documentation

◆ AdvertiseMessageOptions() [1/2]

Constructor.

◆ AdvertiseMessageOptions() [2/2]

Copy constructor.

Parameters
[in]_otherAdvertiseMessageOptions to copy.

◆ ~AdvertiseMessageOptions()

virtual ~AdvertiseMessageOptions ( )
virtual

Destructor.

Member Function Documentation

◆ MsgsPerSec()

uint64_t MsgsPerSec ( ) const

Get the maximum number of messages per second to be published.

Returns
The maximum number of messages per second.

◆ operator!=()

bool operator!= ( const AdvertiseMessageOptions _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=()

AdvertiseMessageOptions& operator= ( const AdvertiseMessageOptions _other)

Assignment operator.

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

◆ operator==()

bool operator== ( const AdvertiseMessageOptions _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.

◆ SetMsgsPerSec()

void SetMsgsPerSec ( const uint64_t  _newMsgsPerSec)

Set the maximum number of messages per second to be published. Note that we calculate the minimum period of a message based on the msgs/sec rate. Any message sent since the last Publish() and the duration of the period will be discarded.

Parameters
[in]_newMsgsPerSecMaximum number of messages per second.

◆ Throttled()

bool Throttled ( ) const

Whether the publication has been throttled.

Returns
true when the publication is throttled or false otherwise.
See also
SetMsgsPerSec
MsgsPerSec

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream _out,
const AdvertiseMessageOptions _other 
)
friend

Stream insertion operator.

Parameters
[out]_outThe output stream.
[in]_otherAdvertiseMessageOptions to write to the stream.

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