dds::core::policy::UserData Class Reference

More...

#include "CorePolicy.hpp"

Inherits dds::core::Value< D >.

Public Member Functions
	UserData ()
	UserData (const dds::core::ByteSeq &sequence)
	UserData (const uint8_t *value_begin, const uint8_t *value_end)
	UserData (const UserData &other)
const uint8_t *	begin () const
const uint8_t *	end () const
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator== (const Value &other) const
const dds::core::ByteSeq	value () const
UserData &	value (const dds::core::ByteSeq &sequence)
template<typename OCTET_ITER >
UserData &	value (OCTET_ITER begin, OCTET_ITER end)

Detailed Description

Definition at line 41 of file CorePolicy.hpp.

Constructor & Destructor Documentation

UserData() [1/4]

dds::core::policy::UserData::UserData

(

)

Creates a UserData QoS instance with an empty UserData

UserData() [2/4]

dds::core::policy::UserData::UserData ( const dds::core::ByteSeq &  sequence )

explicit

Creates a UserData QoS instance

Parameters

sequence

the sequence of octets

UserData() [3/4]

dds::core::policy::UserData::UserData	(	const uint8_t *	value_begin,
		const uint8_t *	value_end
	)

Creates a UserData QoS instance

Parameters

value_begin	a pointer to the beginning of a sequence of octets
value_end	a pointer to the end of a sequence of octets

UserData() [4/4]

dds::core::policy::UserData::UserData

(

const UserData &

other

)

Copies a UserData QoS instance

Parameters

other

the UserData QoS instance to copy

Member Function Documentation

begin()

const uint8_t* dds::core::policy::UserData::begin

(

)

const

Gets a pointer to the first octet in the sequence

Returns

a pointer to the first octet in the sequence

end()

const uint8_t* dds::core::policy::UserData::end

(

)

const

Gets a pointer to the last octet in the sequence

Returns

a pointer to the first octet in the sequence

operator!=()

template<typename D >

bool dds::core::Value< D >::operator!= ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if not equal

operator->() [1/2]

template<typename D >

D* dds::core::Value< D >::operator-> ( )

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

operator->() [2/2]

template<typename D >

const D* dds::core::Value< D >::operator-> ( ) const

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Value and on all its subclasses as follows:

my_dds_value.standard_function();
my_dds_value->vendor_specific_extension();

Returns

a reference to delegate.

operator==()

template<typename D >

bool dds::core::Value< D >::operator== ( const Value< D > &  other ) const

inherited

Compare this Value with another Value

Parameters

other

Value

Returns

true if equal

value() [1/3]

const dds::core::ByteSeq dds::core::policy::UserData::value

(

)

const

Gets the sequence

Returns

a sequence of octets

value() [2/3]

UserData& dds::core::policy::UserData::value

(

const dds::core::ByteSeq &

sequence

)

Sets the sequence

Parameters

sequence

a sequence of octets

value() [3/3]

template<typename OCTET_ITER >

UserData& dds::core::policy::UserData::value	(	OCTET_ITER	begin,
		OCTET_ITER	end
	)

Sets the sequence

Parameters

begin	an iterator pointing to the beginning of a sequence of octets
end	an iterator pointing to the end of a sequence of octets

---

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

• dds/core/policy/CorePolicy.hpp