ignition::transport::AdvertiseServiceOptions Class Reference

A class for customizing the publication options for a service advertised. More...

#include <AdvertiseOptions.hh>

Inheritance diagram for ignition::transport::AdvertiseServiceOptions:

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. More...
AdvertiseServiceOptions &	operator= (const AdvertiseServiceOptions &_other)
	Assignment operator. More...
bool	operator== (const AdvertiseServiceOptions &_other) const
	Equality operator. More...
size_t	Pack (char *_buffer) const
	Serialize the options. More...
size_t	Unpack (const char *_buffer)
	Unserialize the options. More...
Public Member Functions inherited from ignition::transport::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. 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 AdvertiseServiceOptions &_other)
	Stream insertion operator. More...

Detailed Description

A class for customizing the publication options for a service advertised.

Constructor & Destructor Documentation

AdvertiseServiceOptions() [1/2]

ignition::transport::AdvertiseServiceOptions::AdvertiseServiceOptions

(

)

Constructor.

AdvertiseServiceOptions() [2/2]

ignition::transport::AdvertiseServiceOptions::AdvertiseServiceOptions

(

const AdvertiseServiceOptions &

_other

)

Copy constructor.

Parameters

[in]

_other

AdvertiseServiceOptions to copy.

~AdvertiseServiceOptions()

virtual ignition::transport::AdvertiseServiceOptions::~AdvertiseServiceOptions ( )

virtual

Destructor.

Member Function Documentation

MsgLength()

size_t ignition::transport::AdvertiseServiceOptions::MsgLength

(

)

const

Get the total length of the message.

Returns

Return the length of the message in bytes.

operator!=()

bool ignition::transport::AdvertiseServiceOptions::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& ignition::transport::AdvertiseServiceOptions::operator=

(

const AdvertiseServiceOptions &

_other

)

Assignment operator.

Parameters

[in]

_other

The other AdvertiseServiceOptions.

Returns

A reference to this instance.

operator==()

bool ignition::transport::AdvertiseServiceOptions::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 ignition::transport::AdvertiseServiceOptions::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 ignition::transport::AdvertiseServiceOptions::Unpack

(

const char *

_buffer

)

Unserialize the options.

Parameters

[in]

_buffer

Input buffer with the data to be unserialized.

Friends And Related Function Documentation

operator<<

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

friend

Stream insertion operator.

Parameters

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

---

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

• AdvertiseOptions.hh