Public Member Functions | Protected Attributes | List of all members
ignition::transport::AdvertiseOptions Class Reference

ignition/transport/AdvertiseOptions.hh More...

#include <AdvertiseOptions.hh>

Public Member Functions

 AdvertiseOptions ()
 Constructor. More...
 
 AdvertiseOptions (const AdvertiseOptions &_other)
 Copy constructor. More...
 
virtual ~AdvertiseOptions ()
 Destructor. More...
 
AdvertiseOptionsoperator= (const AdvertiseOptions &_other)
 Assignment operator. 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...
 

Protected Attributes

std::unique_ptr< transport::AdvertiseOptionsPrivatedataPtr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ AdvertiseOptions() [1/2]

ignition::transport::AdvertiseOptions::AdvertiseOptions ( )

Constructor.

◆ AdvertiseOptions() [2/2]

ignition::transport::AdvertiseOptions::AdvertiseOptions ( const AdvertiseOptions _other)

Copy constructor.

Parameters
[in]_otherAdvertiseOptions to copy.

◆ ~AdvertiseOptions()

virtual ignition::transport::AdvertiseOptions::~AdvertiseOptions ( )
virtual

Destructor.

Member Function Documentation

◆ operator=()

AdvertiseOptions& ignition::transport::AdvertiseOptions::operator= ( const AdvertiseOptions _other)

Assignment operator.

Parameters
[in]_otherThe new AdvertiseOptions.
Returns
A reference to this instance.

◆ 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
[in]_scopeThe new scope.
See also
Scope.
Scope_t.

Member Data Documentation

◆ dataPtr

std::unique_ptr<transport::AdvertiseOptionsPrivate> ignition::transport::AdvertiseOptions::dataPtr
protected

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