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

#include "BuiltinTopic.hpp"

Inheritance diagram for dds::topic::PublicationBuiltinTopicData:

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::DurabilityService &	durability_service () 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::Lifespan &	lifespan () 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::core::policy::OwnershipStrength &	ownership_strength () 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::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 DataWriters within the system.

The DCPSPublication topic communicates the existence of datawriters by means of the PublicationBuiltinTopicData datatype. Each PublicationBuiltinTopicData sample in a Domain represents a datawriter in that Domain: a new PublicationBuiltinTopicData instance is created when a newly-added DataWriter is enabled, and it is disposed when that DataWriter is deleted. An updated PublicationBuiltinTopicData sample is written each time the DataWriter (or the Publisher to which it belongs) modifies a QosPolicy that applies to the entities connected to it. Also will it be updated when the writer looses or regains its liveliness.

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

See also: Built-in Topics; PublicationBuiltinTopicData

Definition at line 256 of file BuiltinTopic.hpp.

Member Function Documentation

◆ deadline()

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

QosPolicy attached to the DataWriter

Definition at line 217 of file BuiltinTopicImpl.hpp.

◆ destination_order()

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

QosPolicy attached to the DataWriter

Definition at line 278 of file BuiltinTopicImpl.hpp.

◆ durability()

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

QosPolicy attached to the DataWriter

Definition at line 200 of file BuiltinTopicImpl.hpp.

◆ durability_service()

const ::dds::core::policy::DurabilityService & dds::topic::PublicationBuiltinTopicData::durability_service ( ) const

QosPolicy attached to the DataWriter

Definition at line 209 of file BuiltinTopicImpl.hpp.

◆ group_data()

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

QosPolicy attached to the Publisher to which the DataWriter belongs

Definition at line 306 of file BuiltinTopicImpl.hpp.

◆ key()

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

Global unique identifier of the DataWriter

Definition at line 172 of file BuiltinTopicImpl.hpp.

◆ latency_budget()

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

QosPolicy attached to the DataWriter

Definition at line 224 of file BuiltinTopicImpl.hpp.

◆ lifespan()

const ::dds::core::policy::Lifespan & dds::topic::PublicationBuiltinTopicData::lifespan ( ) const

QosPolicy attached to the DataWriter

Definition at line 246 of file BuiltinTopicImpl.hpp.

◆ liveliness()

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

QosPolicy attached to the DataWriter

Definition at line 231 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::PublicationBuiltinTopicData::ownership ( ) const

QosPolicy attached to the DataWriter

Definition at line 260 of file BuiltinTopicImpl.hpp.

◆ ownership_strength()

const ::dds::core::policy::OwnershipStrength & dds::topic::PublicationBuiltinTopicData::ownership_strength ( ) const

QosPolicy attached to the DataWriter

Definition at line 269 of file BuiltinTopicImpl.hpp.

◆ participant_key()

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

Global unique identifier of the Participant to which the DataWriter belongs

Definition at line 179 of file BuiltinTopicImpl.hpp.

◆ partition()

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

QosPolicy attached to the Publisher to which the DataWriter belongs

Definition at line 292 of file BuiltinTopicImpl.hpp.

◆ presentation()

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

QosPolicy attached to the Publisher to which the DataWriter belongs

Definition at line 285 of file BuiltinTopicImpl.hpp.

◆ reliability()

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

QosPolicy attached to the DataWriter

Definition at line 238 of file BuiltinTopicImpl.hpp.

◆ topic_data()

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

QosPolicy attached to the Publisher to which the DataWriter belongs

Definition at line 299 of file BuiltinTopicImpl.hpp.

◆ topic_name()

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

Name of the Topic used by the DataWriter

Definition at line 186 of file BuiltinTopicImpl.hpp.

◆ type_name()

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

Type name of the Topic used by the DataWriter

Definition at line 193 of file BuiltinTopicImpl.hpp.

◆ user_data()

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

QosPolicy attached to the DataWriter

Definition at line 253 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()

◆ durability_service()

◆ group_data()

◆ key()

◆ latency_budget()

◆ lifespan()

◆ liveliness()

◆ operator!=()

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator==()

◆ ownership()

◆ ownership_strength()

◆ participant_key()

◆ partition()

◆ presentation()

◆ reliability()

◆ topic_data()

◆ topic_name()

◆ type_name()

◆ user_data()