dds::topic::ParticipantBuiltinTopicData Class Reference

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

#include "BuiltinTopic.hpp"

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

Public Member Functions
const dds::topic::BuiltinTopicKey &	key () const
bool	operator!= (const Value &other) const
D *	operator-> ()
const D *	operator-> () const
bool	operator== (const Value &other) const
const ::dds::core::policy::UserData &	user_data () const

Detailed Description

Class that contains information about available DomainParticipants within the system.

The DCPSParticipant topic communicates the existence of DomainParticipants by means of the ParticipantBuiltinTopicData datatype. Each ParticipantBuiltinTopicData sample in a Domain represents a DomainParticipant that participates in that Domain: a new ParticipantBuiltinTopicData instance is created when a newly-added DomainParticipant is enabled, and it is disposed when that DomainParticipant is deleted. An updated ParticipantBuiltinTopicData sample is written each time the DomainParticipant modifies its UserDataQosPolicy.

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

See also

DCPS_Builtin_Topics

DCPS_Builtin_Topics_ParticipantData

Definition at line 81 of file BuiltinTopic.hpp.

Member Function Documentation

key()

const dds::topic::BuiltinTopicKey& dds::topic::ParticipantBuiltinTopicData::key

(

)

const

Globally unique identifier of the participant

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

user_data()

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

(

)

const

User-defined data attached to the participant via a QosPolicy

---

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

• dds/topic/BuiltinTopic.hpp