dds::topic::SubscriptionBuiltinTopicData Class Reference

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

#include "BuiltinTopic.hpp"

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

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::eclipse::cyclonedds::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

DCPS_Builtin_Topics

DCPS_Builtin_Topics_SubscriptionData

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

destination_order()

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

(

)

const

QosPolicy attached to the DataReader

durability()

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

(

)

const

QosPolicy attached to the DataReader

group_data()

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

(

)

const

QosPolicy attached to the Subscriber to which the DataReader belongs

key()

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

(

)

const

Global unique identifier of the DataReader

latency_budget()

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

(

)

const

QosPolicy attached to the DataReader

liveliness()

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

(

)

const

QosPolicy attached to the DataReader

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

ownership()

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

(

)

const

QosPolicy attached to the DataReader

participant_key()

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

(

)

const

Global unique identifier of the Participant to which the DataReader belongs

partition()

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

(

)

const

QosPolicy attached to the Subscriber to which the DataReader belongs

presentation()

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

(

)

const

QosPolicy attached to the Subscriber to which the DataReader belongs

reliability()

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

(

)

const

QosPolicy attached to the DataReader

time_based_filter()

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

(

)

const

QosPolicy attached to the DataReader

topic_data()

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

(

)

const

QosPolicy attached to the Subscriber to which the DataReader belongs

topic_name()

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

(

)

const

Name of the Topic used by the DataReader

type_name()

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

(

)

const

Type name of the Topic used by the DataReader

user_data()

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

(

)

const

QosPolicy attached to the DataReader

---

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

• dds/topic/BuiltinTopic.hpp