ignition::transport::AdvertiseOptions Class Reference

ignition/transport/AdvertiseOptions.hh More...

#include <AdvertiseOptions.hh>

Inheritance diagram for ignition::transport::AdvertiseOptions:

Public Member Functions
	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. More...
AdvertiseOptions &	operator= (const AdvertiseOptions &_other)
	Assignment operator. More...
bool	operator== (const AdvertiseOptions &_other) const
	Equality operator. More...
size_t	Pack (char *_buffer) const
	Serialize the options. 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. More...

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

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

ignition::transport::AdvertiseOptions::AdvertiseOptions

(

)

Constructor.

ignition::transport::AdvertiseOptions::AdvertiseOptions

(

const AdvertiseOptions &

_other

)

Copy constructor.

Parameters

[in]

_other

AdvertiseOptions to copy.

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

virtual

Destructor.

Member Function Documentation

size_t ignition::transport::AdvertiseOptions::MsgLength

(

)

const

Get the total length of the message.

Returns

Return the length of the message in bytes.

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.

AdvertiseOptions& ignition::transport::AdvertiseOptions::operator=

(

const AdvertiseOptions &

_other

)

Assignment operator.

Parameters

[in]

_other

The new AdvertiseOptions.

Returns

A reference to this instance.

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.

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.

const Scope_t& ignition::transport::AdvertiseOptions::Scope

(

)

const

Get the scope used in this topic/service.

Returns

The scope.

See Also

SetScope.

Scope_t.

void ignition::transport::AdvertiseOptions::SetScope

(

const Scope_t &

_scope

)

Set the scope of the topic or service.

Parameters

[in]

_scope

The new scope.

See Also

Scope.

Scope_t.

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.

Friends And Related Function Documentation

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

friend

Stream insertion operator.

Parameters

[out]	_out	The output stream.
[in]	_other	AdvertiseOptions to write to the stream.

---

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

• AdvertiseOptions.hh