Class that contains information about available DataReaders within the system. More...

#include "BuiltinTopic.hpp"

Inheritance diagram for dds::topic::SubscriptionBuiltinTopicData:

Public Member Functions
const ::dds::core::policy::Deadline &	deadline () const

const ::dds::core::policy::DestinationOrder &	destination_order () const

const ::dds::core::policy::Durability &	durability () const

const ::dds::core::policy::GroupData &	group_data () const

const dds::topic::BuiltinTopicKey &	key () const

const ::dds::core::policy::LatencyBudget &	latency_budget () const

const ::dds::core::policy::Liveliness &	liveliness () const

bool	operator!= (const Value &other) const

D *	operator-> ()

const D *	operator-> () const

bool	operator== (const Value &other) const

const ::dds::core::policy::Ownership &	ownership () const

const dds::topic::BuiltinTopicKey &	participant_key () const

const ::dds::core::policy::Partition &	partition () const

const ::dds::core::policy::Presentation &	presentation () const

const ::dds::core::policy::Reliability &	reliability () const

const ::dds::core::policy::TimeBasedFilter &	time_based_filter () const

const ::dds::core::policy::TopicData &	topic_data () const

const std::string &	topic_name () const

const std::string &	type_name () const

const ::dds::core::policy::UserData &	user_data () const

Detailed Description

Class that contains information about available DataReaders within the system.

The DCPSSubscription topic communicates the existence of datareaders by means of the SubscriptionBuiltinTopicData datatype. Each SubscriptionBuiltinTopicData sample in a Domain represents a datareader in that Domain: a new SubscriptionBuiltinTopicData instance is created when a newly-added DataReader is enabled, and it is disposed when that DataReader is deleted. An updated SubscriptionBuiltinTopicData sample is written each time the DataReader (or the Subscriber to which it belongs) modifies a QosPolicy that applies to the entities connected to it.

// Get builtin subscriber
dds::domain::DomainParticipant participant(org::opensplice::domain::default_id());
dds::sub::Subscriber builtinSubscriber = dds::sub::builtin_subscriber(participant);
// Get DCPSSubscription builtin reader (happy flow)
string name = "DCPSSubscription";
vector<dds::sub::DataReader<dds::topic::SubscriptionBuiltinTopicData> > readersVector;
dds::sub::find<dds::sub::DataReader<dds::topic::SubscriptionBuiltinTopicData>,
                      back_insert_iterator<vector<dds::sub::DataReader<dds::topic::SubscriptionBuiltinTopicData> > > >(
          builtinSubscriber,
          name,
          back_inserter<vector<dds::sub::DataReader<dds::topic::SubscriptionBuiltinTopicData> > >(readersVector));
dds::sub::DataReader<dds::topic::SubscriptionBuiltinTopicData> builtinReader = readersVector[0];
// The builtinReader can now be used just as a normal dds::sub::DataReader to get
// dds::topic::SubscriptionBuiltinTopicData samples.

See also: Built-in Topics; SubscriptionBuiltinTopicData

Definition at line 397 of file BuiltinTopic.hpp.

Member Function Documentation

◆ deadline()

const ::dds::core::policy::Deadline & dds::topic::SubscriptionBuiltinTopicData::deadline ( ) const

QosPolicy attached to the DataReader

Definition at line 350 of file BuiltinTopicImpl.hpp.

◆ destination_order()

const ::dds::core::policy::DestinationOrder & dds::topic::SubscriptionBuiltinTopicData::destination_order ( ) const

QosPolicy attached to the DataReader

Definition at line 385 of file BuiltinTopicImpl.hpp.

◆ durability()

const ::dds::core::policy::Durability & dds::topic::SubscriptionBuiltinTopicData::durability ( ) const

QosPolicy attached to the DataReader

Definition at line 343 of file BuiltinTopicImpl.hpp.

◆ group_data()

const ::dds::core::policy::GroupData & dds::topic::SubscriptionBuiltinTopicData::group_data ( ) const

QosPolicy attached to the Subscriber to which the DataReader belongs

Definition at line 427 of file BuiltinTopicImpl.hpp.

◆ key()

const dds::topic::BuiltinTopicKey & dds::topic::SubscriptionBuiltinTopicData::key ( ) const

Global unique identifier of the DataReader

Definition at line 315 of file BuiltinTopicImpl.hpp.

◆ latency_budget()

const ::dds::core::policy::LatencyBudget & dds::topic::SubscriptionBuiltinTopicData::latency_budget ( ) const

QosPolicy attached to the DataReader

Definition at line 357 of file BuiltinTopicImpl.hpp.

◆ liveliness()

const ::dds::core::policy::Liveliness & dds::topic::SubscriptionBuiltinTopicData::liveliness ( ) const

QosPolicy attached to the DataReader

Definition at line 364 of file BuiltinTopicImpl.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.

◆ ownership()

const ::dds::core::policy::Ownership & dds::topic::SubscriptionBuiltinTopicData::ownership ( ) const

QosPolicy attached to the DataReader

Definition at line 378 of file BuiltinTopicImpl.hpp.

◆ participant_key()

const dds::topic::BuiltinTopicKey & dds::topic::SubscriptionBuiltinTopicData::participant_key ( ) const

Global unique identifier of the Participant to which the DataReader belongs

Definition at line 322 of file BuiltinTopicImpl.hpp.

◆ partition()

const ::dds::core::policy::Partition & dds::topic::SubscriptionBuiltinTopicData::partition ( ) const

QosPolicy attached to the Subscriber to which the DataReader belongs

Definition at line 413 of file BuiltinTopicImpl.hpp.

◆ presentation()

const ::dds::core::policy::Presentation & dds::topic::SubscriptionBuiltinTopicData::presentation ( ) const

QosPolicy attached to the Subscriber to which the DataReader belongs

Definition at line 406 of file BuiltinTopicImpl.hpp.

◆ reliability()

const ::dds::core::policy::Reliability & dds::topic::SubscriptionBuiltinTopicData::reliability ( ) const

QosPolicy attached to the DataReader

Definition at line 371 of file BuiltinTopicImpl.hpp.

◆ time_based_filter()

const ::dds::core::policy::TimeBasedFilter & dds::topic::SubscriptionBuiltinTopicData::time_based_filter ( ) const

QosPolicy attached to the DataReader

Definition at line 399 of file BuiltinTopicImpl.hpp.

◆ topic_data()

const ::dds::core::policy::TopicData & dds::topic::SubscriptionBuiltinTopicData::topic_data ( ) const

QosPolicy attached to the Subscriber to which the DataReader belongs

Definition at line 420 of file BuiltinTopicImpl.hpp.

◆ topic_name()

const std::string & dds::topic::SubscriptionBuiltinTopicData::topic_name ( ) const

Name of the Topic used by the DataReader

Definition at line 329 of file BuiltinTopicImpl.hpp.

◆ type_name()

const std::string & dds::topic::SubscriptionBuiltinTopicData::type_name ( ) const

Type name of the Topic used by the DataReader

Definition at line 336 of file BuiltinTopicImpl.hpp.

◆ user_data()

const ::dds::core::policy::UserData & dds::topic::SubscriptionBuiltinTopicData::user_data ( ) const

QosPolicy attached to the DataReader

Definition at line 392 of file BuiltinTopicImpl.hpp.

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

include/dcps/C++/isocpp2/dds/topic/BuiltinTopic.hpp
include/dcps/C++/isocpp2/dds/topic/detail/BuiltinTopicImpl.hpp

Public Member Functions

Detailed Description

Member Function Documentation

◆ deadline()

◆ destination_order()

◆ durability()

◆ group_data()

◆ key()

◆ latency_budget()

◆ liveliness()

◆ operator!=()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator==()

◆ ownership()

◆ participant_key()

◆ partition()

◆ presentation()

◆ reliability()

◆ time_based_filter()

◆ topic_data()

◆ topic_name()

◆ type_name()

◆ user_data()