dds::core::policy::TopicData Class Reference

More...

#include "CorePolicy.hpp"

Inheritance diagram for dds::core::policy::TopicData:

Public Member Functions
	TopicData ()
	TopicData (const dds::core::ByteSeq &sequence)
	TopicData (const TopicData &other)
	TopicData (const uint8_t *value_begin, const uint8_t *value_end)
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
TopicData &	value (const dds::core::ByteSeq &sequence)
template<typename OCTET_ITER >
TopicData &	value (OCTET_ITER begin, OCTET_ITER end)
const dds::core::ByteSeq	value () const

Detailed Description

This QosPolicy allows the application to attach additional information to a Topic Entity. This information is distributed with the BuiltinTopics.

Attributes

Value	Meaning	Concerns	RxO	Changeable
A sequence of octets: value	A sequence of octets that holds the application topic data. By default, the sequence has length 0.	Topic	No	Yes

The purpose of this QoS is to allow the application to attach additional information to the created Topic such that when a remote application discovers their existence it can examine the information and use it in an application-defined way. In combination with the listeners on the DataReader and DataWriter as well as by means of operations such as ignore_topic, these QoS can assist an application to extend the provided QoS.

Definition at line 197 of file CorePolicy.hpp.

Constructor & Destructor Documentation

TopicData() [1/4]

dds::core::policy::TopicData::TopicData

(

)

Creates a TopicData QoS instance

Definition at line 206 of file CorePolicyImpl.hpp.

TopicData() [2/4]

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

explicit

Creates a TopicData QoS instance

Parameters

sequence

the sequence of octets representing the TopicData

Definition at line 209 of file CorePolicyImpl.hpp.

TopicData() [3/4]

dds::core::policy::TopicData::TopicData

(

const TopicData &

other

)

Copies a TopicData QoS instance

Parameters

other

the TopicData QoS instance to copy

Definition at line 212 of file CorePolicyImpl.hpp.

TopicData() [4/4]

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

Creates a TopicData 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

Definition at line 216 of file CorePolicyImpl.hpp.

Member Function Documentation

begin()

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

(

)

const

Gets a pointer to the first octet in the sequence

Returns

a pointer to the first octet in the sequence

Definition at line 252 of file CorePolicyImpl.hpp.

end()

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

(

)

const

Gets a pointer to the last octet in the sequence

Returns

a pointer to the last octet in the sequence

Definition at line 267 of file CorePolicyImpl.hpp.

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

Definition at line 99 of file Value.hpp.

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.

Definition at line 111 of file Value.hpp.

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.

Definition at line 105 of file Value.hpp.

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

Definition at line 93 of file Value.hpp.

value() [1/3]

TopicData & dds::core::policy::TopicData::value

(

const dds::core::ByteSeq &

sequence

)

Set the sequence

Parameters

sequence

a sequence of octets

Definition at line 222 of file CorePolicyImpl.hpp.

value() [2/3]

template<typename OCTET_ITER >

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

Set 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

Definition at line 231 of file CorePolicyImpl.hpp.

value() [3/3]

const dds::core::ByteSeq dds::core::policy::TopicData::value

(

)

const

Get the sequence

Returns

a sequence of octets

Definition at line 245 of file CorePolicyImpl.hpp.

---

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

• include/dcps/C++/isocpp2/dds/core/policy/CorePolicy.hpp
• include/dcps/C++/isocpp2/dds/core/policy/detail/CorePolicyImpl.hpp