dds::core::policy::GroupData Class Reference

More...

#include "CorePolicy.hpp"

Inheritance diagram for dds::core::policy::GroupData:

Public Member Functions
	GroupData ()
	GroupData (const dds::core::ByteSeq &sequence)
	GroupData (const GroupData &other)
	GroupData (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
GroupData &	value (const dds::core::ByteSeq &sequence)
template<typename OCTET_ITER >
GroupData &	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 Publisher or Subscriber Entity. This information is distributed with the BuiltinTopics.

Attributes

Value	Meaning	Concerns	RxO	Changeable
A sequence of octects: value	User data not known by the middleware, but distributed by means of built-in topics. The default value is an empty (zero- sized) sequence.	Publisher, Subscriber	No	Yes

The purpose of this QoS is to allow the application to attach additional information to the created Publisher or Subscriber. The value of the GROUP_DATA is available to the application on the DataReader and DataWriter entities and is propagated by means of the built-in topics.

This QoS can be used by an application combination with the DataReaderListener and DataWriterListener to implement matching policies similar to those of the PARTITION QoS except the decision can be made based on an application-defined policy.

Definition at line 119 of file CorePolicy.hpp.

Constructor & Destructor Documentation

GroupData() [1/4]

dds::core::policy::GroupData::GroupData

(

)

Creates a GroupData QoS instance

Definition at line 123 of file CorePolicyImpl.hpp.

GroupData() [2/4]

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

explicit

Creates a GroupData QoS instance

Parameters

sequence

the sequence of octets representing the GroupData

Definition at line 126 of file CorePolicyImpl.hpp.

GroupData() [3/4]

dds::core::policy::GroupData::GroupData

(

const GroupData &

other

)

Copies a GroupData QoS instance

Parameters

other

the GroupData QoS instance to copy

Definition at line 129 of file CorePolicyImpl.hpp.

GroupData() [4/4]

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

Creates a GroupData 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 132 of file CorePolicyImpl.hpp.

Member Function Documentation

begin()

const uint8_t * dds::core::policy::GroupData::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 175 of file CorePolicyImpl.hpp.

end()

const uint8_t * dds::core::policy::GroupData::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 190 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]

GroupData & dds::core::policy::GroupData::value

(

const dds::core::ByteSeq &

sequence

)

Set the sequence

Parameters

sequence

a sequence of octets

Definition at line 145 of file CorePolicyImpl.hpp.

value() [2/3]

template<typename OCTET_ITER >

GroupData & dds::core::policy::GroupData::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 154 of file CorePolicyImpl.hpp.

value() [3/3]

const dds::core::ByteSeq dds::core::policy::GroupData::value

(

)

const

Get the sequence

Returns

a sequence of octets

Definition at line 168 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